-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: update the docstring of pandas.Series.clip #20256
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.
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
DOC: update the docstring of pandas.Series.clip #20256
Conversation
Docstrings validator shows some errors related to *args and **kwargs and the dot '.' that can not be avoided. |
Currently working on the |
Examples small improvements
Fixed versionadded
pandas/core/generic.py
Outdated
|
||
Returns | ||
------- | ||
clipped : Series | ||
`pandas.Series` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we quote here, the original: clipped : Series
is fine
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Made a small change to make it generic for Series and DataFrame.
Since there is another PR that also edits this docstring (# #20212), will merge this, and we can further refine in the other PR
Continuation of #20178
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 --diff
python 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