Merge pull request #8008 from tacaswell/doc_document_set_size_inches_forward_change

NelleV · web-flow · commit 493cb8ae34ac · 2017-02-02T09:13:43.000-08:00
DOC: add missing docs for change to Figure.set_size_inches
diff --git a/doc/users/dflt_style_changes.rst b/doc/users/dflt_style_changes.rst
@@ -256,6 +256,12 @@ or by setting::
 
 In your :file:`matplotlibrc` file.
 
+In addition, the ``forward`` kwarg to
+`~matplotlib.Figure.set_size_inches` now defaults to `True` to improve
+the interactive experience.  Backend canvases that adjust the size of
+their bound `matplotlib.figure.Figure` must pass ``forward=False`` to
+avoid circular behavior.  This default is not configurable.
+
 
 Plotting functions
 ==================
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -682,15 +682,12 @@ def figimage(self, X,
         return im
 
     def set_size_inches(self, w, h=None, forward=True):
-        """
-        set_size_inches(w,h, forward=False)
-
-        Set the figure size in inches (1in == 2.54cm)
+        """Set the figure size in inches (1in == 2.54cm)
 
-        Usage::
+        Usage ::
 
              fig.set_size_inches(w,h)  # OR
-             fig.set_size_inches((w,h) )
+             fig.set_size_inches((w,h))
 
         optional kwarg *forward=True* will cause the canvas size to be
         automatically updated; e.g., you can resize the figure window
