Skip to content

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

Closed
wants to merge 2 commits into from

Conversation

radovankavicky
Copy link

@radovankavicky radovankavicky commented Mar 10, 2018

Update

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

  • PR title is "DOC: update the docstring"
  • The validation script passes: scripts/validate_docstrings.py <your-function-or-method>
  • The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
  • The html version looks good: python doc/make.py --single <your-function-or-method>
  • It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

# paste output of "scripts/validate_docstrings.py <your-function-or-method>" here
# between the "```" (remove this comment, but keep the "```")

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):

  • closes #xxxx
  • tests added / passed
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

Update
@pep8speaks
Copy link

pep8speaks commented Mar 10, 2018

Hello @radovankavicky! Thanks for updating the PR.

Line 32:1: W293 blank line contains whitespace

Comment last updated on March 10, 2018 at 12:23 Hours UTC

@radovankavicky radovankavicky changed the title Update DOC: update the docstring Mar 10, 2018
@radovankavicky radovankavicky changed the title DOC: update the docstring DOC: update the pickle.py docstring Mar 10, 2018
@jreback jreback added Docs IO Data IO issues that don't fit into a more specific label labels Mar 10, 2018
@@ -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

Copy link
Contributor

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
Copy link
Contributor

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?

@jorisvandenbossche
Copy link
Member

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!

@jorisvandenbossche jorisvandenbossche added this to the No action milestone Mar 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO Data IO issues that don't fit into a more specific label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants