Merge pull request #7029 from mobando/master

tacaswell · tacaswell · commit 03701811bc35 · 2016-09-24T15:09:22.000-04:00
DOC: Updated documentation of arrow function to numpy docs format.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4530,13 +4530,34 @@ def arrow(self, x, y, dx, dy, **kwargs):
         """
         Add an arrow to the axes.
 
-        Call signature::
+        Draws arrow on specified axis from (`x`, `y`) to (`x` + `dx`,
+        `y` + `dy`). Uses FancyArrow patch to construct the arrow.
+
+        Parameters
+        ----------
+        x : float
+            X-coordinate of the arrow base
+        y : float
+            Y-coordinate of the arrow base
+        dx : float
+            Length of arrow along x-coordinate
+        dy : float
+            Length of arrow along y-coordinate
+
+        Returns
+        -------
+        a : FancyArrow
+            patches.FancyArrow object
 
-           arrow(x, y, dx, dy, **kwargs)
+        Other Parameters
+        -----------------
+        Optional kwargs (inherited from FancyArrow patch) control the arrow
+        construction and properties:
 
-        Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,
-        *y* + *dy*). Uses FancyArrow patch to construct the arrow.
+        %(FancyArrow)s
 
+        Notes
+        -----
         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
@@ -4545,13 +4566,11 @@ def arrow(self, x, y, dx, dy, **kwargs):
             ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0),
                 arrowprops=dict(arrowstyle="->"))
 
-        Optional kwargs control the arrow construction and properties:
-
-        %(FancyArrow)s
-
-        **Example:**
+        Examples
+        --------
 
         .. plot:: mpl_examples/pylab_examples/arrow_demo.py
+
         """
         # Strip away units for the underlying patch since units
         # do not make sense to most patch-like code
