Merge pull request #26001 from meeseeksmachine/auto-backport-of-pr-25954-on-v3.7.x

rcomer · web-flow · commit 28eb201cba0a · 2023-05-29T23:03:11.000+01:00
Backport PR #25954 on branch v3.7.x (Add note that subfigure is still provisional to docstring)
diff --git a/examples/subplots_axes_and_figures/subfigures.py b/examples/subplots_axes_and_figures/subfigures.py
@@ -14,7 +14,7 @@
 that subfigures can also have their own child subfigures.
 
 .. note::
-    ``subfigure`` is new in v3.4, and the API is still provisional.
+    The *subfigure* concept is new in v3.4, and the API is still provisional.
 
 """
 import matplotlib.pyplot as plt
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1539,6 +1539,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::
+            The *subfigure* concept is new in v3.4, and the API is still provisional.
+
         Parameters
         ----------
         nrows, ncols : int, default: 1
@@ -2140,6 +2143,9 @@ 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.
     """
     callbacks = _api.deprecated(
             "3.6", alternative=("the 'resize_event' signal in "
