DOC: Mark subfigures as no longer provisional #28849
Merged
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
rcomer
reviewed
Sep 20, 2024
27aed81 to
5943680
Compare
timhoffm
reviewed
Sep 20, 2024
Comment on lines
4
to
5
| The API on `.Figure.subfigures` and `.SubFigure` are now considered stable and | ||
| will change under Matplotlib's normal deprecation process. |
There was a problem hiding this comment.
Suggested change
| The API on `.Figure.subfigures` and `.SubFigure` are now considered stable and | |
| will change under Matplotlib's normal deprecation process. | |
| The API on `.Figure.subfigures` and `.SubFigure` are now considered stable. |
I would leave that out. It confuses more than it helps. What people read from this is "The API ... will change". What we want to communicate is that the API does not change (and if there should arise a need for change, it will be announced beforehand and include a migration path). But that's just the standard way of working in the library and does not need explicit mentioning.
There was a problem hiding this comment.
5943680 to
33fd5b1
Compare
timhoffm
approved these changes
Sep 21, 2024
8 tasks
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.
PR summary
Fixes #25947
PR checklist