-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
ENH: Add StringMethod.find and rfind #9386
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
end : int | ||
Right edge index | ||
side : {'left', 'right'}, default 'left' | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would document this as switching between find
(left side) and rfind
(right side).
96e0799
to
a3298db
Compare
Thanks, fixed. |
OK, looks good to me. |
def str_find(arr, sub, start=0, end=None, side='left'): | ||
""" | ||
Return indexes in each strings where the substring is | ||
wholly contained between [start:end]. Return -1 on failure. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'wholly' sounds a bit odd to me (non-native speaker), is 'fully' better?
@sinhrks I added some documentation comments. Further:
|
and another:
|
Modified once.
|
""") | ||
|
||
@Appender(_shared_docs['find'] % dict(side='lowest', | ||
also='rfind : Return highest indexes in each strings')) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think rfind
has to be Series.str.rfind
(and same below)
And on the note, I don't think that is a problem that is would be duplicated (that is the point of having both docstrings and narrative docs, there will always be some duplication). If the table in text.rst can be replaced by an autosummary table is separate issue I think. Positive side is that it would add the explanation manually, but at the moment I like more how the table looks in text.rst (better overview) than how it is on the api pages. |
It is maybe not necessary to add it in a Note, just adding 'equivalent to standard library's str.find' in the explanation in the beginning of the docstring is also good. |
47f6ce7
to
f4089b7
Compare
Maybe my word choice is inappropriate. What I'm caring is uniformity of styles and descriptions. What I expect is all the docstring should have similar format, and sufficient information in a single place. In this respect, current doc should be revised in separate PR to cover:
This is one thing, and added a description for this PR. |
ENH: Add StringMethod.find and rfind
thanks @sinhrks |
Derived from #9111.