SF.net SVN: matplotlib:[8722] branches/v1_0_maint

[<ef...@us...>]

Revision: 8722
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=8722&view=rev
Author:   efiring
Date:     2010-09-27 18:51:05 +0000 (Mon, 27 Sep 2010)

Log Message:
-----------
Clarify docstrings for autoscale_view and relim.

Modified Paths:
--------------
    branches/v1_0_maint/doc/pyplots/tex_demo.png
    branches/v1_0_maint/lib/matplotlib/axes.py

Modified: branches/v1_0_maint/doc/pyplots/tex_demo.png
===================================================================
(Binary files differ)

Modified: branches/v1_0_maint/lib/matplotlib/axes.py
===================================================================
--- branches/v1_0_maint/lib/matplotlib/axes.py	2010-09-27 01:51:50 UTC (rev 8721)
+++ branches/v1_0_maint/lib/matplotlib/axes.py	2010-09-27 18:51:05 UTC (rev 8722)
@@ -1491,7 +1491,12 @@
         return tab
 
     def relim(self):
-        'recompute the data limits based on current artists'
+        """
+        Recompute the data limits based on current artists.
+
+        At present, :class:`~matplotlib.collections.Collection`
+        instances are not supported.
+        """
         # Collections are deliberately not supported (yet); see
         # the TODO note in artists.py.
         self.dataLim.ignore(True)
@@ -1760,10 +1765,16 @@
 
     def autoscale_view(self, tight=None, scalex=True, scaley=True):
         """
-        autoscale the view limits using the data limits. You can
+        Autoscale the view limits using the data limits. You can
         selectively autoscale only a single axis, eg, the xaxis by
         setting *scaley* to *False*.  The autoscaling preserves any
         axis direction reversal that has already been done.
+
+        The data limits are not updated automatically when artist
+        data are changed after the artist has been added to an
+        Axes instance.  In that case, use
+        :meth:`matplotlib.axes.Axes.relim`
+        prior to calling autoscale_view.
         """
         if tight is not None:
             self._tight = bool(tight)


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.