Skip to content

DOC: Fixed docstring for mode() #35624

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.

Sign up for GitHub

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
merged 5 commits into from
Aug 22, 2020
Merged

DOC: Fixed docstring for mode() #35624

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f424e39
DOC: Fixed docstring for mode()
MarianD Aug 8, 2020
5eb9637
DOC: Changed docstring for mode()
MarianD Aug 9, 2020
c167857
Update pandas/core/series.py
MarianD Aug 9, 2020
0f3e9a4
DOC: Changes in docstring for mode()
MarianD Aug 22, 2020
e932f12
Update pandas/core/series.py
MarianD Aug 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1786,7 +1786,10 @@ def count(self, level=None):

def mode(self, dropna=True) -> "Series":
"""
Return the mode(s) of the dataset.
Return the mode(s) of the series.

The mode is the value that appears most often.
It can be multiple values.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this fit on one line? Otherwise LGTM.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@MarcoGorelli MarcoGorelli Aug 22, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcoGorelli, thanks for your tip, done.


Always returns Series even if only one value is returned.

Expand Down