AnchoredDirectionArrows: Docstring, what's new

idahj · idahj · commit 6ec4f8fc64b6 · 2017-08-25T13:14:26.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
@@ -9,7 +9,7 @@ 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.
+and text layout, these are passed to :class:`matplotlib.text.TextPath` and
+`matplotlib.patches.FancyArrowPatch`. Location, length and width for both
+arrow tail 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
@@ -476,8 +476,8 @@ def __init__(self, transform, label_x, label_y, length=0.15,
             Defaults to 2.
 
         text_props, arrow_props : dict
-            Properties of the text and arrows, passed to :class:
-            `matplotlib.text.TextPath` and
+            Properties of the text and arrows, passed to
+            :class:`matplotlib.text.TextPath` and
             `matplotlib.patches.FancyArrowPatch`
 
         **kwargs :
@@ -509,11 +509,10 @@ def __init__(self, transform, label_x, label_y, length=0.15,
         >>> import matplotlib.pyplot as plt
         >>> import numpy as np
         >>> from mpl_toolkits.axes_grid1.anchored_artists import \
-AnchoredDirectionArrows
+        ...     AnchoredDirectionArrows
         >>> fig, ax = plt.subplots()
         >>> ax.imshow(np.random.random((10,10)))
-        >>> arrows = AnchoredDirectionArrows(ax.transAxes, '111', \
-r'11$\overline{2}$')
+        >>> arrows = AnchoredDirectionArrows(ax.transAxes, '111', '110')
         >>> ax.add_artist(arrows)
         >>> fig.show()
 
@@ -522,9 +521,10 @@ def __init__(self, transform, label_x, label_y, length=0.15,
 
         >>> import matplotlib.font_manager as fm
         >>> fontprops = fm.FontProperties(family='monospace')
-        >>> arrows = AnchoredDirectionArrows(ax.transAxes,'East','South', \
-loc='lower left', color='k', aspect_ratio=-1, sep_x=0.02,sep_y=-0.01, \
-text_props={'ec':'w','fc':'k'}, fontproperties=fontprops)
+        >>> arrows = AnchoredDirectionArrows(ax.transAxes, 'East', 'South',
+        ... loc='lower left', color='k', aspect_ratio=-1, sep_x=0.02,
+        ... sep_y=-0.01, text_props={'ec':'w', 'fc':'k'},
+        ... fontproperties=fontprops)
         """
         if arrow_props is None:
             arrow_props = {}
