Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 81674c3

Browse files
committed
Clarify docstrings for autoscale_view and relim.
svn path=/branches/v1_0_maint/; revision=8722
1 parent c542e38 commit 81674c3

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

doc/pyplots/tex_demo.png

7.16 KB
Loading

lib/matplotlib/axes.py

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1491,7 +1491,12 @@ def add_table(self, tab):
14911491
return tab
14921492

14931493
def relim(self):
1494-
'recompute the data limits based on current artists'
1494+
"""
1495+
Recompute the data limits based on current artists.
1496+
1497+
At present, :class:`~matplotlib.collections.Collection`
1498+
instances are not supported.
1499+
"""
14951500
# Collections are deliberately not supported (yet); see
14961501
# the TODO note in artists.py.
14971502
self.dataLim.ignore(True)
@@ -1760,10 +1765,16 @@ def autoscale(self, enable=True, axis='both', tight=None):
17601765

17611766
def autoscale_view(self, tight=None, scalex=True, scaley=True):
17621767
"""
1763-
autoscale the view limits using the data limits. You can
1768+
Autoscale the view limits using the data limits. You can
17641769
selectively autoscale only a single axis, eg, the xaxis by
17651770
setting *scaley* to *False*. The autoscaling preserves any
17661771
axis direction reversal that has already been done.
1772+
1773+
The data limits are not updated automatically when artist
1774+
data are changed after the artist has been added to an
1775+
Axes instance. In that case, use
1776+
:meth:`matplotlib.axes.Axes.relim`
1777+
prior to calling autoscale_view.
17671778
"""
17681779
if tight is not None:
17691780
self._tight = bool(tight)

0 commit comments

Comments
 (0)