Skip to content

DOC: Fix #24268 by updating description for keep in Series.nlargest #25358

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 11 commits into from
Mar 5, 2019
Merged

DOC: Fix #24268 by updating description for keep in Series.nlargest #25358

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2ebe8ae
DOC: Fix #24268 by updating description for keep
bharatr21 Feb 18, 2019
ab33dc1
Fix PEP8 issues and a typo
bharatr21 Feb 18, 2019
794f370
Fix PEP8 issues
bharatr21 Feb 18, 2019
28aa45b
Update the description of keep
bharatr21 Feb 19, 2019
c9de2f6
Fix PEP8 issues again
bharatr21 Feb 19, 2019
62ccfed
Fix trailing whitespaces
bharatr21 Feb 19, 2019
8506a6e
Fix some docstring issues (as produced by tests)
bharatr21 Feb 19, 2019
fdb6ba7
Take suggestions from @TomAugspurger and @WillAyd to improve readability
Feb 27, 2019
310682a
Rewording docs according to @WillAyd 's suggestion
bharatr21 Mar 1, 2019
5c56fad
Merge remote-tracking branch 'upstream/master'
bharatr21 Mar 2, 2019
9a8367d
Removed the confusing lines as suggested by @jreback
bharatr21 Mar 3, 2019
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
14 changes: 9 additions & 5 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3098,8 +3098,10 @@ def nlargest(self, n=5, keep='first'):
When there are duplicate values that cannot all fit in a
Series of `n` elements:

- ``first`` : take the first occurrences based on the index order
- ``last`` : take the last occurrences based on the index order
- ``first`` : return the first `n` occurrences in order
of appearance.
- ``last`` : return the last `n` occurrences in reverse
order of appearance.
- ``all`` : keep all occurrences. This can result in a Series of
size larger than `n`.

Expand Down Expand Up @@ -3194,8 +3196,10 @@ def nsmallest(self, n=5, keep='first'):
When there are duplicate values that cannot all fit in a
Series of `n` elements:

- ``first`` : take the first occurrences based on the index order
- ``last`` : take the last occurrences based on the index order
- ``first`` : return the first `n` occurrences in order
of appearance.
- ``last`` : return the last `n` occurrences in reverse
order of appearance.
- ``all`` : keep all occurrences. This can result in a Series of
size larger than `n`.

Expand Down Expand Up @@ -3236,7 +3240,7 @@ def nsmallest(self, n=5, keep='first'):
Monserat 5200
dtype: int64

The `n` largest elements where ``n=5`` by default.
The `n` smallest elements where ``n=5`` by default.

>>> s.nsmallest()
Monserat 5200
Expand Down