Merge pull request #1278 from dmcdougall/arrow_transdata_doc

dmcdougall · dmcdougall · commit fc170806a1af · 2012-11-12T21:10:41.000-08:00
Make arrow docstring mention data transform
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -6597,6 +6597,10 @@ def arrow(self, x, y, dx, dy, **kwargs):
         Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,
         *y* + *dy*). Uses FancyArrow patch to construct the arrow.
 
+        The resulting arrow is affected by the axes aspect ratio and limits. This
+        may produce an arrow whose head is not square with its stem. To create
+        an arrow whose head is square with its stem, use :meth:`annotate`.
+
         Optional kwargs control the arrow construction and properties:
 
         %(FancyArrow)s
