Skip to content

DOC: Mark subfigures as no longer provisional #28849

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.

Sign up for GitHub

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
Sep 21, 2024
+8 −12
Merged

DOC: Mark subfigures as no longer provisional #28849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/users/next_whats_new/subfigures_change_order.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
Subfigures no longer provisional
--------------------------------

The API on `.Figure.subfigures` and `.SubFigure` are now considered stable.


Subfigures are now added in row-major order
-------------------------------------------

Expand Down
3 changes: 0 additions & 3 deletions galleries/examples/subplots_axes_and_figures/subfigures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
`matplotlib.figure.Figure.subfigures` to make an array of subfigures. Note
that subfigures can also have their own child subfigures.

.. note::
The *subfigure* concept is new in v3.4, and the API is still provisional.

"""
import matplotlib.pyplot as plt
import numpy as np
Expand Down
11 changes: 2 additions & 9 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@
Many methods are implemented in `FigureBase`.

`SubFigure`
A logical figure inside a figure, usually added to a figure (or parent
`SubFigure`) with `Figure.add_subfigure` or `Figure.subfigures` methods
(provisional API v3.4).
A logical figure inside a figure, usually added to a figure (or parent `SubFigure`)
with `Figure.add_subfigure` or `Figure.subfigures` methods.

Figures are typically created using pyplot methods `~.pyplot.figure`,
`~.pyplot.subplots`, and `~.pyplot.subplot_mosaic`.
Expand Down Expand Up @@ -1608,9 +1607,6 @@ 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::
The *subfigure* concept is new in v3.4, and the API is still provisional.

.. versionchanged:: 3.10
subfigures are now added in row-major order.

Expand Down Expand Up @@ -2229,9 +2225,6 @@ class SubFigure(FigureBase):
axsR = sfigs[1].subplots(2, 1)

See :doc:`/gallery/subplots_axes_and_figures/subfigures`

.. note::
The *subfigure* concept is new in v3.4, and the API is still provisional.
"""

def __init__(self, parent, subplotspec, *,
Expand Down
Loading