Merge pull request #25954 from timhoffm/subfigure-provisional

QuLogic · web-flow · commit 3d3a1afd6d7c · 2023-05-29T15:51:59.000-04:00
Add note that subfigure is still provisional to docstring
diff --git a/galleries/examples/subplots_axes_and_figures/subfigures.py b/galleries/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
@@ -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::
+            The *subfigure* concept is new in v3.4, and the API is still provisional.
+
         Parameters
         ----------
         nrows, ncols : int, default: 1
@@ -2151,6 +2154,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.
     """
 
     def __init__(self, parent, subplotspec, *,
