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

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

Changes from 1 commit
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
Prev Previous commit
Next Next commit
Update the description of keep 
Update according to suggestion by @TomAugsperger
  • Loading branch information
@bharatr21
bharatr21 authored Feb 19, 2019
commit 28aa45b938934c25e5fbedec01439d86ab9225ea
6 changes: 6 additions & 0 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3107,6 +3107,9 @@ def nlargest(self, n=5, keep='first'):
- ``all`` : keep all occurrences. This can result in a Series of
size larger than `n`.

The `keep` parameter determines which ones to keep when there are duplicates.
Regardless of `keep`, the result will be sorted by the row label.

Returns
-------
Series
Expand Down Expand Up @@ -3204,6 +3207,9 @@ def nsmallest(self, n=5, keep='first'):
reverse of the given index order.
- ``all`` : keep all occurrences. This can result in a Series of
size larger than `n`.

The `keep` parameter determines which ones to keep when there are duplicates.
Regardless of `keep`, the result will be sorted by the row label.

Returns
-------
Expand Down