Reorder text api docs. #22540
Merged
Reorder text api docs. #22540
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Text/Annotation/OffsetFrom seems like a nicer order than the alphabetical Annotation/OffsetFrom/Text. Also, the toplevel get_rotation probably doesn't even warrant an entry...
oscargus
approved these changes
Feb 23, 2022
QuLogic
approved these changes
Feb 24, 2022
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 24, 2022
QuLogic
added a commit
that referenced
this pull request
Feb 24, 2022
…540-on-v3.5.x Backport PR #22540 on branch v3.5.x (Reorder text api docs.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Text/Annotation/OffsetFrom seems like a nicer order than the
alphabetical Annotation/OffsetFrom/Text. Also, the toplevel
get_rotation probably doesn't even warrant an entry...
(this was the reason for #22539)
We could consider at some point using some degree of autodoc_member_order = "bysource" (https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_member_order) but that would be a much longer-term thing. (Plus it would be nice to have e.g. automodules by source and autoclasses by alphabetical order, something that may be doable with member-order.)
PR Summary
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).