DOC Series.sort_values docstring [Sao Paulo] #1
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
villasv
suggested changes
Mar 10, 2018
pandas/core/series.py
Outdated
|
|
||
| **Sort values ascending order** | ||
|
|
||
| >>> s.sort_values(ascending= True) |
There was a problem hiding this comment.
No spaces surrounding = for keyword arguments.
pandas/core/series.py
Outdated
|
|
||
| **Sort values descending order** | ||
|
|
||
| >>> s.sort_values(ascending= False) |
There was a problem hiding this comment.
No spaces surrounding = for keyword arguments.
pandas/core/series.py
Outdated
|
|
||
| **Sort values inplace** | ||
|
|
||
| >>> s.sort_values(ascending= False, inplace= True) |
There was a problem hiding this comment.
No spaces surrounding = for keyword arguments.
pandas/core/series.py
Outdated
|
|
||
| **Sort values putting NAs first** | ||
|
|
||
| >>> s.sort_values(na_position= 'first') |
There was a problem hiding this comment.
No spaces surrounding = for keyword arguments.
|
PEP8: 4th bullet point in: https://www.python.org/dev/peps/pep-0008/#other-recommendations |
villasv
suggested changes
Mar 10, 2018
pandas/core/series.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| sorted_obj : Series |
There was a problem hiding this comment.
Returned values need not to be named except if inside tuples.
pandas/core/series.py
Outdated
| 7 45.0 | ||
| dtype: float64 | ||
|
|
||
| **Sort values ascending order** |
There was a problem hiding this comment.
Is this using bold font? The guidelines don't forbid it explicitly but simply says:
Sort values ascending order:
igorcadelima
suggested changes
Mar 10, 2018
amuta
approved these changes
Mar 10, 2018
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.
Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):
scripts/validate_docstrings.py <your-function-or-method>git diff upstream/master -u -- "*.py" | flake8 --diffpython doc/make.py --single <your-function-or-method>Please include the output of the validation script below between the "```" ticks:
If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.
Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):
git diff upstream/master -u -- "*.py" | flake8 --diff