Merge pull request #11714 from fredrik-1/doc_Figure_tight_layout

jklymak · web-flow · commit 0766e5365cff · 2018-07-20T06:34:30.000-07:00
docstring for Figure.tight_layout don't include renderer parameter
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2324,7 +2324,10 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
 
         Parameters
         ----------
-        pad : float
+        renderer : subclass of `~.backend_bases.RendererBase`, optional
+            Defaults to the renderer for the figure.
+
+        pad : float, optional
             Padding between the figure edge and the edges of subplots,
             as a fraction of the font size.
         h_pad, w_pad : float, optional
@@ -2334,6 +2337,11 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
             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).
+
+        See Also
+        --------
+        .Figure.set_tight_layout
+        .pyplot.tight_layout
         """
 
         from .tight_layout import (
