Merge pull request #17229 from anntzer/subplots_adjust

tacaswell · web-flow · commit 2f7a58d83c99 · 2020-04-23T20:48:29.000-04:00
MNT: Autogenerate subplots_adjust with boilerplate.py.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2217,8 +2217,31 @@ def colorbar(self, mappable, cax=None, ax=None, use_gridspec=True, **kw):
     def subplots_adjust(self, left=None, bottom=None, right=None, top=None,
                         wspace=None, hspace=None):
         """
-        Update the `SubplotParams` with *kwargs* (defaulting to rc when
-        *None*), and update the subplot locations.
+        Adjust the subplot layout parameters.
+
+        Unset parameters are left unmodified; initial values are given by
+        :rc:`figure.subplot.[name]`.
+
+        Parameters
+        ----------
+        left : float, optional
+            The position of the left edge of the subplots,
+            as a fraction of the figure width.
+        right : float, optional
+            The position of the right edge of the subplots,
+            as a fraction of the figure width.
+        bottom : float, optional
+            The position of the bottom edge of the subplots,
+            as a fraction of the figure height.
+        top : float, optional
+            The position of the top edge of the subplots,
+            as a fraction of the figure height.
+        wspace : float, optional
+            The width of the padding between subplots,
+            as a fraction of the average axes width.
+        hspace : float, optional
+            The height of the padding between subplots,
+            as a fraction of the average axes height.
         """
         if self.get_constrained_layout():
             self.set_constrained_layout(False)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1287,28 +1287,6 @@ def twiny(ax=None):
     return ax1
 
 
-def subplots_adjust(left=None, bottom=None, right=None, top=None,
-                    wspace=None, hspace=None):
-    """
-    Tune the subplot layout.
-
-    The parameter meanings (and suggested defaults) are::
-
-      left = 0.125  # the left side of the subplots of the figure
-      right = 0.9   # the right side of the subplots of the figure
-      bottom = 0.1  # the bottom of the subplots of the figure
-      top = 0.9     # the top of the subplots of the figure
-      wspace = 0.2  # the amount of width reserved for space between subplots,
-                    # expressed as a fraction of the average axis width
-      hspace = 0.2  # the amount of height reserved for space between subplots,
-                    # expressed as a fraction of the average axis height
-
-    The actual defaults are controlled by the rc file
-    """
-    fig = gcf()
-    fig.subplots_adjust(left, bottom, right, top, wspace, hspace)
-
-
 def subplot_tool(targetfig=None):
     """
     Launch a subplot tool window for a figure.
@@ -2223,6 +2201,16 @@ def ginput(
         mouse_stop=mouse_stop)
 
 
+# Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
+@_copy_docstring_and_deprecators(Figure.subplots_adjust)
+def subplots_adjust(
+        left=None, bottom=None, right=None, top=None, wspace=None,
+        hspace=None):
+    return gcf().subplots_adjust(
+        left=left, bottom=bottom, right=right, top=top, wspace=wspace,
+        hspace=hspace)
+
+
 # Autogenerated by boilerplate.py.  Do not edit as changes will be lost.
 @_copy_docstring_and_deprecators(Figure.suptitle)
 def suptitle(t, **kwargs):
diff --git a/tools/boilerplate.py b/tools/boilerplate.py
@@ -188,6 +188,7 @@ def boilerplate_gen():
         'gca',
         'gci:_gci',
         'ginput',
+        'subplots_adjust',
         'suptitle',
         'waitforbuttonpress',
     )

Original file line number	Diff line number	Diff line change
`@@ -188,6 +188,7 @@ def boilerplate_gen():`
`188`	`188`	`'gca',`
`189`	`189`	`'gci:_gci',`
`190`	`190`	`'ginput',`
	`191`	`+ 'subplots_adjust',`
`191`	`192`	`'suptitle',`
`192`	`193`	`'waitforbuttonpress',`
`193`	`194`	`)`