DOC: Fixed docstring for mode() #35624
Merged
Conversation
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
- Explanation of mode() function
MarcoGorelli
reviewed
Aug 9, 2020
Co-authored-by: Marco Gorelli <[email protected]>
dsaxton
approved these changes
Aug 20, 2020
pandas/core/series.py
Outdated
| Return the mode(s) of the Series. | ||
|
|
||
| The mode is the value that appears most often. | ||
| It can be multiple values. |
There was a problem hiding this comment.
Can this fit on one line? Otherwise LGTM.
There was a problem hiding this comment.
The first line of a docstring is limited to 55 characters. Other 2 lines in my suggestion will be displayed in the documentation anyway as 1 line.
There was a problem hiding this comment.
@MarianD can't these 2 extra lines you've added fit on a single line?
In [6]: len(""" The mode is the value that appears most often. It can be multiple values.""")
Out[6]: 81
There was a problem hiding this comment.
@MarcoGorelli, thanks for your tip, done.
- Fixed 1st line of docstring - Added explanation for mode() function - Explanation for mode(): joined 2 lines into 1
MarcoGorelli
approved these changes
Aug 22, 2020
dsaxton
reviewed
Aug 22, 2020
Co-authored-by: Daniel Saxton <[email protected]>
MarcoGorelli
approved these changes
Aug 22, 2020
|
Thanks @MarianD |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff