AnchoredDirectionArrows: docstring, what's new

idahj · idahj · commit 88d04d07d024 · 2017-08-23T14:19:06.000+01:00
diff --git a/doc/users/next_whats_new/anchored_direction_arrows.rst b/doc/users/next_whats_new/anchored_direction_arrows.rst
@@ -0,0 +1,15 @@
+Add ``AnchoredDirectionArrows`` feature to mpl_toolkits
+--------------------------------------------------------
+
+A new mpl_toolkits class
+:class:`~mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows`
+draws a pair of orthogonal arrows to inidcate directions on a 2D plot. A
+minimal working example takes in the transformation object for the coordinate
+system (typically ax.transAxes), and arrow labels. There are several optional
+parameters that can be used to alter layout. For example, the arrow pairs can
+be rotated and the color can be changed. By default the labels and arrows have
+the same color, but the class may also pass arguments for costumizing arrow
+and text layout, these are passed to :class: `matplotlib.text.TextPath` and
+`matplotlib.patches.FancyArrowPatch`. Location, arrow lenght, width and head
+can be adjusted, the the direction arrows and labels can have a frame. Padding
+and separation parameters can be adjusted.
diff --git a/lib/mpl_toolkits/axes_grid1/anchored_artists.py b/lib/mpl_toolkits/axes_grid1/anchored_artists.py
@@ -393,7 +393,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
         ----------
         transform : `matplotlib.transforms.Transform`
             The transformation object for the coordinate system in use, i.e.,
-            :attr:`matplotlib.axes.Axes.transData`.
+            :attr:`matplotlib.axes.Axes.transAxes`.
 
         label_x, label_y : string
             Label text for the x and y arrows
