Documentation for the autoscale contextmanager.

matplotlib · Nov 23, 2015 · 90397f9 · 90397f9
1 parent 4f30cce
commit 90397f9
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -11,6 +11,19 @@ sources of the changes you are experiencing.
 For new features that were added to matplotlib, please see
 :ref:`whats-new`.
 
+Changes in 2.1.0
+================
+
+Code changes
+------------
+
+autoscale is now a context manager
+``````````````````````````````````
+
+Instead of returning None, ``plt.autoscale`` and ``Axes.autoscale``
+now return a context manager, which allows one to restore the previous
+autoscaling status upon exiting the block.
+
 Changes in 2.0.0
 ================
 

diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -23,6 +23,18 @@ revision, see the :ref:`github-stats`.
 .. contents:: Table of Contents
    :depth: 3
 
+.. _whats-new-2-1:
+
+new in matplotlib-2.1
+=====================
+
+autoscale is now a context manager
+----------------------------------
+
+Instead of returning None, ``plt.autoscale`` and ``Axes.autoscale``
+now return a context manager, which allows one to restore the previous
+autoscaling status upon exiting the block.
+
 .. _whats-new-1-5:
 
 new in matplotlib-1.5

diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -2109,13 +2109,8 @@ def autoscale(self, enable=True, axis='both', tight=None):
 
             with axes.autoscale(enable): ...
 
-        or::
-
-            @axes.autoscale(enable)
-            def func(): ...
-
         will keep the autoscale status to `enable` for the duration of the
-        block or function and then restore it to its original value.
+        block only.
         """
         orig_autoscale = self._autoscaleXon, self._autoscaleYon
         if enable is not None: