Merge pull request #11061 from fredrik-1/doc_tight_layout

dstansby · web-flow · commit db3be2372db2 · 2018-04-17T09:55:38.000+01:00
Changed tight_layout doc strings
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2066,20 +2066,18 @@ def execute_constrained_layout(self, renderer=None):
     def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
                      rect=None):
         """
-        Adjust subplot parameters to give specified padding.
+        Automatically adjust subplot parameters to give specified padding.
 
         Parameters
         ----------
         pad : float
-            padding between the figure edge and the edges of subplots,
-            as a fraction of the font-size.
-
+            Padding between the figure edge and the edges of subplots,
+            as a fraction of the font size.
         h_pad, w_pad : float, optional
-            padding (height/width) between edges of adjacent subplots.
-            Defaults to `pad_inches`.
-
+            Padding (height/width) between edges of adjacent subplots,
+            as a fraction of the font size.  Defaults to *pad*.
         rect : tuple (left, bottom, right, top), optional
-            a rectangle (left, bottom, right, top) in the normalized
+            A rectangle (left, bottom, right, top) in the normalized
             figure coordinate that the whole subplots area (including
             labels) will fit into. Default is (0, 0, 1, 1).
         """
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1256,15 +1256,15 @@ def tight_layout(pad=1.08, h_pad=None, w_pad=None, rect=None):
     Parameters
     ----------
     pad : float
-        padding between the figure edge and the edges of subplots, as a fraction of the font-size.
-    h_pad, w_pad : float
-        padding (height/width) between edges of adjacent subplots.
-        Defaults to `pad_inches`.
-    rect : if rect is given, it is interpreted as a rectangle
-        (left, bottom, right, top) in the normalized figure
-        coordinate that the whole subplots area (including
+        Padding between the figure edge and the edges of subplots,
+        as a fraction of the font size.
+    h_pad, w_pad : float, optional
+        Padding (height/width) between edges of adjacent subplots,
+        as a fraction of the font size.  Defaults to *pad*.
+    rect : tuple (left, bottom, right, top), optional
+        A rectangle (left, bottom, right, top) in the normalized
+        figure coordinate that the whole subplots area (including
         labels) will fit into. Default is (0, 0, 1, 1).
-
     """
     fig = gcf()
     fig.tight_layout(pad=pad, h_pad=h_pad, w_pad=w_pad, rect=rect)
