Add note that subfigure is still provisional to docstring #25954
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
oscargus
reviewed
May 23, 2023
lib/matplotlib/figure.py
Outdated
| @@ -1552,6 +1552,9 @@ def subfigures(self, nrows=1, ncols=1, squeeze=True, | |||
| the same as a figure, but cannot print itself. | |||
| See :doc:`/gallery/subplots_axes_and_figures/subfigures`. | |||
|
|
|||
| .. note:: | |||
| ``subfigure`` is new in v3.4, and the API is still provisional. | |||
There was a problem hiding this comment.
Should this be subfigures? (As in the method name?)
There was a problem hiding this comment.
I've just copied from https://matplotlib.org/stable/gallery/subplots_axes_and_figures/subfigures.html#figure-subfigures
Likely it's intended to be broader than just the single method, e.g.
The subfigure concept is new in v3.4, ...
Possibly we should rewrite both notes that way, and also add it to https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.SubFigure I will follow up with a PR later.
0e96cbc to
aaeda87
Compare
QuLogic
approved these changes
May 29, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
May 29, 2023
…ional to docstring
rcomer
added a commit
that referenced
this pull request
May 29, 2023
…954-on-v3.7.x Backport PR #25954 on branch v3.7.x (Add note that subfigure is still provisional to docstring)
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.
Assuming we still leave is provisional in 3.8 per #25947 (comment)
This matches the notes at https://matplotlib.org/stable/gallery/subplots_axes_and_figures/subfigures.html#figure-subfigures