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

Skip to content

DOC: Tweaks to module API pages #20319

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 4 commits into from
May 31, 2021
Merged

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented May 28, 2021

PR Summary

This fixes some minor typos on module pages, and some tweaks to callouts and inheritance diagrams.

Strong recommendations at the top of module are now .. important, less strong are now .. note. I dropped extra classes from the date and transform inheritance diagrams. I'm not sure if Artist should hide _AnnotationBase and ScalaraMappable as well?

I also noted that the table is lightly maintained and that blume may be preferable, but I'm not sure if we should just point at the third-party page in general?

PR Checklist

  • [n/a] Has pytest style unit tests (and pytest passes).
  • 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).
  • 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).

@QuLogic QuLogic added this to the v3.5.0 milestone May 28, 2021
@timhoffm timhoffm merged commit 0520d99 into matplotlib:master May 31, 2021
@QuLogic QuLogic deleted the doc-api-pages branch May 31, 2021 21:02
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