-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: update the pickle.py docstring #20106
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
Conversation
Hello @radovankavicky! Thanks for updating the PR.
Comment last updated on March 10, 2018 at 12:23 Hours UTC |
update
@@ -29,8 +29,8 @@ def to_pickle(obj, path, compression='infer', protocol=pkl.HIGHEST_PROTOCOL): | |||
For Python >= 3.4, 4 is a valid value. A negative value for the | |||
protocol parameter is equivalent to setting its value to | |||
HIGHEST_PROTOCOL. | |||
|
|||
.. [1] https://docs.python.org/3/library/pickle.html | |||
|
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.
extra whitespace
|
||
.. [1] https://docs.python.org/3/library/pickle.html | ||
.. [1] https://docs.python.org/3.1/library/pickle.html | ||
.. versionadded:: 0.21.0 |
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.
is there a generic link here?
This is being updated by #20253 as well, so therefore closing this one. @radovankavicky I hope there was no error in the docstring assignment, in that case sorry! |
Update
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