Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Cleanup docstrings #16524

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

Merged
merged 1 commit into from
Feb 18, 2020
Merged

Cleanup docstrings #16524

merged 1 commit into from
Feb 18, 2020

Conversation

timhoffm
Copy link
Member

PR Summary

Docstring cleanups:

  • (Half)-sentences should always end with a period (PEP-257: The docstring is a phrase ending in a period; and numpydoc style)
  • pydocstyle D200: One-line docstring should fit on one line with quotes.
  • No trailing blank lines in docstrings.
  • Blank line after class docstring. (PEP-257: Insert a blank line after all docstrings (one-line or multi-line) that document a class -- generally speaking, the class's methods are separated from each other by a single blank line, and the docstring needs to be offset from the first method by a blank line.)
  • Some other misc cleanups.

Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

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

postci

@NelleV NelleV merged commit ec153a5 into matplotlib:master Feb 18, 2020
@NelleV
Copy link
Member

NelleV commented Feb 18, 2020

Thanks @timhoffm !

@timhoffm timhoffm deleted the doc-clean branch February 18, 2020 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants