Skip to content

Docstring cleanups. #20973

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
Sep 2, 2021
Merged

Docstring cleanups. #20973

merged 1 commit into from
Sep 2, 2021

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 2, 2021

Mostly D401 (imperative mood) fixes, and a few other things.

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

Mostly D401 (imperative mood) fixes, and a few other things.
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

it's better even if my comments are ignored, I'm just confused

"""
The artist class that will be returned for SimpleArrow style.
"""
"""The artist class that will be returned for SimpleArrow style."""
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"""The artist class that will be returned for SimpleArrow style."""
"""The artist returned when arrow style is SimpleArrow"""

"""
The artist class that will be returned for SimpleArrow style.
"""
"""The artist class that will be returned for SimpleArrow style."""
Copy link
Member

Choose a reason for hiding this comment

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

What triggers this versus returning the SimpleArrow above?

@anntzer
Copy link
Contributor Author

anntzer commented Sep 2, 2021

Probably the whole axisline_style needs rewording, but let's not do that here.

@story645 story645 merged commit 039c94a into matplotlib:master Sep 2, 2021
@anntzer anntzer deleted the d401 branch September 2, 2021 11:39
@QuLogic QuLogic modified the milestones: v3.6.0, v3.5.0 Sep 2, 2021
@QuLogic
Copy link
Member

QuLogic commented Sep 2, 2021

@meeseeksdev backport to v3.5.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 2, 2021
QuLogic added a commit that referenced this pull request Sep 2, 2021
…973-on-v3.5.x

Backport PR #20973 on branch v3.5.x (Docstring cleanups.)
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
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.

3 participants