From 7901d97695aa7c402575d6e39d88618695e71373 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Mon, 29 May 2023 15:51:59 -0400 Subject: [PATCH] Backport PR #25954: Add note that subfigure is still provisional to docstring --- examples/subplots_axes_and_figures/subfigures.py | 2 +- lib/matplotlib/figure.py | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/examples/subplots_axes_and_figures/subfigures.py b/examples/subplots_axes_and_figures/subfigures.py index 4a95932fe7f5..8a4f70a2ac0b 100644 --- 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 index 8dd73fa9b5a1..a24a0050d8f8 100644 --- 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 "