DOC : clarified doc of add_artist

tacaswell · tacaswell · commit 17cd3631a3c3 · 2014-06-03T11:54:53.000-04:00
Added note about add_artist not automatically updating
the data limits used by the auto-scaling.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1423,8 +1423,12 @@ def has_data(self):
             len(self.patches)) > 0
 
     def add_artist(self, a):
-        """
-        Add any :class:`~matplotlib.artist.Artist` to the axes.
+        """Add any :class:`~matplotlib.artist.Artist` to the axes.
+
+        Use `add_artist` only for artists for which there is no dedicated
+        "add" method; and if necessary, use a method such as
+        `update_datalim` or `update_datalim_numerix` to manually update the
+        dataLim if the artist is to be included in autoscaling.
 
         Returns the artist.
         """
