Skip to content

Document what pyplot expects from a backend. #24218

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
Nov 21, 2022

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Oct 19, 2022

PR Summary

(split out of #23101 to make that easier to go in first; goes on top of it.)

Closes #12324.

Now ready to go.

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • 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).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

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.

General note: You use parentheses for additional comments a lot. I suggest you try and reduce their use.

@anntzer
Copy link
Contributor Author

anntzer commented Nov 13, 2022

Thanks for the review. I've addressed all points except the last one, which I'm not really sure of how to handle and would suggest deferring.

@timhoffm timhoffm merged commit 8dd1f3a into matplotlib:main Nov 21, 2022
@anntzer anntzer deleted the backend-docs branch November 21, 2022 19:05
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.

DOC: Write a unified backend doc
2 participants