Skip to content

DOC: update the Series.sort_values docstring #20215

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 1 commit into from

Conversation

rafarui
Copy link
Contributor

@rafarui rafarui commented Mar 10, 2018

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

@pep8speaks
Copy link

Hello @rafarui! Thanks for submitting the PR.

Line 1888:5: E265 block comment should start with '# '
Line 1894:80: E501 line too long (86 > 79 characters)
Line 1905:80: E501 line too long (123 > 79 characters)
Line 1908:80: E501 line too long (86 > 79 characters)
Line 1923:80: E501 line too long (83 > 79 characters)

@@ -1885,10 +1885,110 @@ def update(self, other):
# ----------------------------------------------------------------------
# Reindexing, sorting

@Appender(generic._shared_docs['sort_values'] % _shared_doc_kwargs)
#@Appender(generic._shared_docs['sort_values'] % _shared_doc_kwargs)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have removed the Apender because it was not generic. It was made for DataFrame.

@rafarui rafarui closed this Mar 10, 2018
@TomAugspurger
Copy link
Contributor

@rafarui do you wish to continue working on this? Sorry we didn't have a chance to review it yesterdya, but if you reopen I'll take a look.

@rafarui
Copy link
Contributor Author

rafarui commented Mar 11, 2018

@TomAugspurger
No need, I had opened this pull request by mistake. The "right"one is this one
#20247

Thanks

@TomAugspurger TomAugspurger added the Duplicate Report Duplicate issue or pull request label Mar 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Duplicate Report Duplicate issue or pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants