diff --git a/doc/users/dflt_style_changes.rst b/doc/users/dflt_style_changes.rst index 8c0422a70a0a..15f2015fbed7 100644 --- 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 index 77dad88ba23d..8f3b3afe7c03 100644 --- 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
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: