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

Skip to content

DOC Use 'Axes' in _axes.py docstrings #18806

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 2 commits into from
Oct 26, 2020
Merged

Conversation

lucyleeow
Copy link
Contributor

@lucyleeow lucyleeow commented Oct 24, 2020

PR Summary

Towards #18726
Use Axes instead of axes in _axes.py.

PR Checklist

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

@lucyleeow lucyleeow changed the title DOC us 'Axes' in _axes.py docstrings DOC Use 'Axes' in _axes.py docstrings Oct 24, 2020
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Thanks. Looks good, with one exception that's already been wrong on our side.

typically used for matrices and images.

Note that the vertical axes points upward for 'lower'
Note that the vertical Axes points upward for 'lower'
Copy link
Member

Choose a reason for hiding this comment

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

Actually this should have been a singular:

Suggested change
Note that the vertical Axes points upward for 'lower'
Note that the vertical axis points upward for 'lower'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you, I should have caught that!

@timhoffm timhoffm added this to the v3.4.0 milestone Oct 26, 2020
@timhoffm timhoffm merged commit 06514d2 into matplotlib:master Oct 26, 2020
@timhoffm
Copy link
Member

Thanks @lucyleeow! Congratulations on your first PR to Matplotlib πŸŽ‰ We hope to hear from you again.

@lucyleeow lucyleeow deleted the doc_axes branch October 26, 2020 00:58
jeromefv pushed a commit to jeromefv/matplotlib that referenced this pull request Nov 6, 2020
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