-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: update the pandas.DataFrame.clip_lower docstring #20289
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
Merged
jorisvandenbossche
merged 7 commits into
pandas-dev:master
from
adatasetaday:docstring_pandas.DataFrame.clip_lower
Jul 8, 2018
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d1bb286
DOC: update the pandas.DataFrame.clip_lower docstring
adatasetaday 22a256f
DOC: update the pandas.DataFrame.clip_lower docstring
adatasetaday 5312dd0
DOC: update the pandas.DataFrame.clip_lower docstring
adatasetaday ba4c362
DOC: update the pandas.DataFrame.clip_lower docstring
adatasetaday 13c9d82
DOC: update the pandas.DataFrame.clip_lower docstring
adatasetaday 4e2e0d7
Merge remote-tracking branch 'upstream/master' into adatasetaday-docs…
jorisvandenbossche e48d49b
fixup
jorisvandenbossche File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Ideally, for
DataFrame.clip_lower
we would like to have inSee Also
:Series.clip_lower
DataFrame.clip
DataFrame.clip_upper
So, the same in
Series
and nothing else fromSeries
. And the similar from the same class (DataFrame
). As this is being reused by bothSeries
andDataFrame
, I'd probably list allclip
,clip_lower
andclip_upper
, but I'm not sure. @jreback ?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.
Only caveat here is that the user is working on a doc that is shared by
Series
andDataFrame
. Mentioned earlier that without further updates (i.e. implementing substitution) that theclip_lower
reference would be self-referential half of the time.I advised just removing it to not get hung up on it for now, the other option would be to explicitly list both
DataFrame.clip_lower
andSeries.clip_lower
and live with the fact that one will be self referencing. No strong preference on my end.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.
Sorry, I was waiting for a little clarification, since I'm not sure how to proceed. I can go either way, but I haven't seen a conclusive definition. Was a decision made on how to proceed with these?
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.
If I'm not wrong, in another ticket the final implementation just listed everything. As @WillAyd says in some cases the same method being documented will be self-referenced, but it's not a big issue.