@@ -4530,13 +4530,34 @@ def arrow(self, x, y, dx, dy, **kwargs):
4530
4530
"""
4531
4531
Add an arrow to the axes.
4532
4532
4533
- Call signature::
4533
+ Draws arrow on specified axis from (`x`, `y`) to (`x` + `dx`,
4534
+ `y` + `dy`). Uses FancyArrow patch to construct the arrow.
4535
+
4536
+ Parameters
4537
+ ----------
4538
+ x : float
4539
+ X-coordinate of the arrow base
4540
+ y : float
4541
+ Y-coordinate of the arrow base
4542
+ dx : float
4543
+ Length of arrow along x-coordinate
4544
+ dy : float
4545
+ Length of arrow along y-coordinate
4546
+
4547
+ Returns
4548
+ -------
4549
+ a : FancyArrow
4550
+ patches.FancyArrow object
4534
4551
4535
- arrow(x, y, dx, dy, **kwargs)
4552
+ Other Parameters
4553
+ -----------------
4554
+ Optional kwargs (inherited from FancyArrow patch) control the arrow
4555
+ construction and properties:
4536
4556
4537
- Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,
4538
- *y* + *dy*). Uses FancyArrow patch to construct the arrow.
4557
+ %(FancyArrow)s
4539
4558
4559
+ Notes
4560
+ -----
4540
4561
The resulting arrow is affected by the axes aspect ratio and limits.
4541
4562
This may produce an arrow whose head is not square with its stem. To
4542
4563
create an arrow whose head is square with its stem, use
@@ -4545,13 +4566,11 @@ def arrow(self, x, y, dx, dy, **kwargs):
4545
4566
ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0),
4546
4567
arrowprops=dict(arrowstyle="->"))
4547
4568
4548
- Optional kwargs control the arrow construction and properties:
4549
-
4550
- %(FancyArrow)s
4551
-
4552
- **Example:**
4569
+ Examples
4570
+ --------
4553
4571
4554
4572
.. plot:: mpl_examples/pylab_examples/arrow_demo.py
4573
+
4555
4574
"""
4556
4575
# Strip away units for the underlying patch since units
4557
4576
# do not make sense to most patch-like code