8000 Inherit more docstrings. by anntzer · Pull Request #21287 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Inherit more docstrings. #21287

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 15, 2021
Merged

Inherit more docstrings. #21287

merged 1 commit into from
Oct 15, 2021

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Oct 5, 2021

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

@jklymak
Copy link
Member
jklymak commented Oct 7, 2021

doc build fails...

@anntzer
Copy link
Contributor Author
anntzer commented Oct 7, 2021

fixed :)

@QuLogic
Copy link
Member
QuLogic commented Oct 7, 2021

One small tweak; the docstring for Artist.get_window_extent says 'Get the axes bounding box in display space.' That of course, doesn't make sense on a Figure or any of the other things that are inheriting, but it never really made sense on the Artist either, so you should remove 'axes' from the docstring.

@anntzer
Copy link
Contributor Author
anntzer commented Oct 8, 2021

good catch, replaced "axes" by "artist's".

@timhoffm timhoffm added this to the v3.5.0 milestone Oct 15, 2021
@timhoffm timhoffm merged commit 9e2f309 into matplotlib:master Oct 15, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 15, 2021
@timhoffm @meeseeksmachine
Backport PR matplotlib#21287: Inherit more docstrings.
0ee1d08
@meeseeksmachine meeseeksmachine mentioned this pull request Oct 15, 2021
Merged
QuLogic added a commit that referenced this pull request Oct 15, 2021
@QuLogic
Merge pull request #21363 from meeseeksmachine/auto-backport-of-pr-21…
3229e8d 
…287-on-v3.5.x

Backport PR #21287 on branch v3.5.x (Inherit more docstrings.)
@anntzer anntzer deleted the id branch October 15, 2021 05:51
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
@timhoffm
Merge pull request #21287 from anntzer/id
7015984 
Inherit more docstrings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.
4 participants
@anntzer @jklymak @QuLogic @timhoffm
0