axis.py: clarify docstring for set_view_interval. Closes issue #118.

efiring · efiring · commit a96422e091d0 · 2011-08-19T16:57:26.000-10:00
Longer term, set_view interval could be deprecated and renamed, but
this is very low priority.
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1724,7 +1724,11 @@ def set_view_interval(self, vmin, vmax, ignore=False):
         """
         If *ignore* is *False*, the order of vmin, vmax
         does not matter; the original axis orientation will
-        be preserved.
+        be preserved. In addition, the view limits can be
+        expanded, but will not be reduced.  This method is
+        for mpl internal use; for normal use, see
+        :meth:`~matplotlib.axes.Axes.set_xlim`.
+
         """
         if ignore:
             self.axes.viewLim.intervalx = vmin, vmax
@@ -1986,7 +1990,11 @@ def set_view_interval(self, vmin, vmax, ignore=False):
         """
         If *ignore* is *False*, the order of vmin, vmax
         does not matter; the original axis orientation will
-        be preserved.
+        be preserved. In addition, the view limits can be
+        expanded, but will not be reduced.  This method is
+        for mpl internal use; for normal use, see
+        :meth:`~matplotlib.axes.Axes.set_ylim`.
+
         """
         if ignore:
             self.axes.viewLim.intervaly = vmin, vmax
