DOC: Edits of example

jklymak · jklymak · commit d53565efa158 · 2020-09-15T15:58:37.000-07:00
diff --git a/examples/subplots_axes_and_figures/subpanels.py b/examples/subplots_axes_and_figures/subpanels.py
@@ -11,6 +11,10 @@
 `.figure.PanelBase.add_subplot`, or `.figure.PanelBase.subpanels` to make
 an array of subpanels.  Note that subpanels can also have their own child
 subpanels.
+
+.. note::
+    ``subpanel`` is new in v3.4, and the api is still provisional.
+
 """
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -8,7 +8,8 @@
 
 `SubPanel`
     A logical figure inside a figure, usually added to a figure or parent
-    `SubPanel` with `.add_subpanel` or `.subpanels` methods.
+    `SubPanel` with `.add_subpanel` or `.subpanels` methods (provisional
+    API v3.4).
 
 `SubplotParams`
     Control the default spacing between subplots.
@@ -1417,6 +1418,35 @@ def subpanels(self, nrows=1, ncols=1, squeeze=True,
                   wspace=None, hspace=None,
                   width_ratios=None, height_ratios=None,
                   **kwargs):
+        """
+        Add a subpanel to this figure or subpanel.  A subpanel has the same
+        artist methods as a figure, and is logically the same as a figure.
+        Parameters
+        ----------
+        nrows, ncols : int, default: 1
+            Number of rows/columns of the subpanel grid.
+
+        squeeze : boolean, default: True
+            If True, extra dimensions are squeezed out from the returned
+            array of subpanels.
+
+        wspace, hspace : float, default: None
+            The amount of width/height reserved for space between subpanels,
+            expressed as a fraction of the average subpanel width.
+            If not given, the values will be inferred from a figure or
+            rcParams when necessary. See also `GridSpec.get_subplot_params`.
+
+        width_ratios : array-like of length *ncols*, optional
+            Defines the relative widths of the columns. Each column gets a
+            relative width of ``width_ratios[i] / sum(width_ratios)``.
+            If not given, all columns will have the same width.
+
+        height_ratios : array-like of length *nrows*, optional
+            Defines the relative heights of the rows. Each column gets a
+            relative height of ``height_ratios[i] / sum(height_ratios)``.
+            If not given, all rows will have the same height.
+
+        """
         gs = GridSpec(nrows=nrows, ncols=ncols, figure=self,
                       wspace=wspace, hspace=hspace,
                       width_ratios=width_ratios,
