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