Skip to content

DOC: improved docstring for pandas.pivot #20151

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

irruka
Copy link

@irruka irruka commented Mar 10, 2018

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

  • [Y] PR title is "DOC: update the docstring"
  • [Y ] 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>
  • [Y ] 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.

@pep8speaks
Copy link

Hello @irruka! Thanks for submitting the PR.

Line 410:1: E101 indentation contains mixed spaces and tabs
Line 410:1: W191 indentation contains tabs
Line 410:1: W293 blank line contains whitespace
Line 411:1: E101 indentation contains mixed spaces and tabs
Line 412:1: E101 indentation contains mixed spaces and tabs
Line 412:1: W191 indentation contains tabs
Line 413:1: W191 indentation contains tabs
Line 414:1: W191 indentation contains tabs
Line 414:35: W291 trailing whitespace
Line 424:1: E101 indentation contains mixed spaces and tabs
Line 424:1: W191 indentation contains tabs
Line 424:1: W293 blank line contains whitespace
Line 425:1: W191 indentation contains tabs
Line 428:1: E101 indentation contains mixed spaces and tabs
Line 428:1: W191 indentation contains tabs
Line 429:1: W191 indentation contains tabs
Line 431:1: E101 indentation contains mixed spaces and tabs
Line 434:1: E101 indentation contains mixed spaces and tabs
Line 434:1: W191 indentation contains tabs
Line 435:1: W191 indentation contains tabs
Line 435:1: W293 blank line contains whitespace
Line 436:1: W191 indentation contains tabs
Line 437:1: W191 indentation contains tabs
Line 438:1: W191 indentation contains tabs
Line 438:1: W293 blank line contains whitespace
Line 439:1: W191 indentation contains tabs
Line 439:77: W291 trailing whitespace
Line 440:1: W191 indentation contains tabs
Line 441:1: W191 indentation contains tabs
Line 441:1: W293 blank line contains whitespace
Line 442:1: W191 indentation contains tabs
Line 443:1: E101 indentation contains mixed spaces and tabs
Line 445:1: E101 indentation contains mixed spaces and tabs
Line 445:1: W191 indentation contains tabs
Line 446:1: W191 indentation contains tabs
Line 446:1: W293 blank line contains whitespace
Line 447:1: W191 indentation contains tabs
Line 448:1: W191 indentation contains tabs
Line 449:1: W191 indentation contains tabs
Line 450:1: W191 indentation contains tabs
Line 450:1: W293 blank line contains whitespace
Line 451:1: W191 indentation contains tabs
Line 452:1: W191 indentation contains tabs
Line 453:1: W191 indentation contains tabs
Line 454:1: W191 indentation contains tabs
Line 454:29: W291 trailing whitespace
Line 455:1: W191 indentation contains tabs
Line 455:1: W293 blank line contains whitespace
Line 456:1: W191 indentation contains tabs
Line 457:1: W191 indentation contains tabs
Line 458:1: W191 indentation contains tabs
Line 459:1: W191 indentation contains tabs
Line 460:1: W191 indentation contains tabs
Line 461:1: W191 indentation contains tabs
Line 462:1: W191 indentation contains tabs
Line 463:1: W191 indentation contains tabs
Line 464:1: W191 indentation contains tabs
Line 465:1: W191 indentation contains tabs
Line 466:1: W191 indentation contains tabs
Line 467:1: W191 indentation contains tabs
Line 468:1: W191 indentation contains tabs
Line 469:1: W191 indentation contains tabs
Line 470:1: W191 indentation contains tabs
Line 471:1: W191 indentation contains tabs
Line 472:1: W191 indentation contains tabs
Line 473:1: W191 indentation contains tabs
Line 474:1: W191 indentation contains tabs
Line 475:1: W191 indentation contains tabs

@jorisvandenbossche
Copy link
Member

@irruka There was apparently also another PR updating pandas.pivot, which has been merged in the meantime: #20250 (I hope this was not due to an error in the docstring assignment from our side, in that case: sorry!)
Can you check the other PR, and see if you have changes in this PR that would still be further improvements compared to what has been merged? And if that is the case, feel free to open a new PR!

@alimcmaster1
Copy link
Member

@jorisvandenbossche think we should be okay to close this given we havn't heard back from @irruka and looks like this was largely addressed in #20250 . @irruka please feel free to re-open if you think otherwise/have any further improvements.

@mroeschke mroeschke closed this Oct 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants