@@ -4522,13 +4522,35 @@ def arrow(self, x, y, dx, dy, **kwargs):
4522
4522
"""
4523
4523
Add an arrow to the axes.
4524
4524
4525
- Call signature::
4526
-
4527
- arrow(x, y, dx, dy, **kwargs)
4528
-
4529
- Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,
4530
- *y* + *dy*). Uses FancyArrow patch to construct the arrow.
4531
-
4525
+ Draws arrow on specified axis from (`x`, `y`) to (`x` + `dx`,
4526
+ `y` + `dy`). Uses FancyArrow patch to construct the arrow.
4527
+
4528
+ Parameters
4529
+ ----------
4530
+ x : float
4531
+ X-coordinate of the arrow base
4532
+ y : float
4533
+ Y-coordinate of the arrow base
4534
+ dx : float
4535
+ Length of arrow in x-coordinate
4536
+ dy : float
4537
+ Length of arrow in y-coordinate
4538
+
4539
+ Return
4540
+ ------
4541
+ a : FancyArrow
4542
+ patches.FancyArrow object
4543
+
4544
+ Other Parameters
4545
+ -----------------
4546
+ kwargs : `~matplotlib.patches.FancyArrow` properties.
4547
+
4548
+ See also
4549
+ --------
4550
+ %(FancyArrow)s : Parent object type.
4551
+
4552
+ Notes
4553
+ -----
4532
4554
The resulting arrow is affected by the axes aspect ratio and limits.
4533
4555
This may produce an arrow whose head is not square with its stem. To
4534
4556
create an arrow whose head is square with its stem, use
@@ -4537,11 +4559,8 @@ def arrow(self, x, y, dx, dy, **kwargs):
4537
4559
ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0),
4538
4560
arrowprops=dict(arrowstyle="->"))
4539
4561
4540
- Optional kwargs control the arrow construction and properties:
4541
-
4542
- %(FancyArrow)s
4543
-
4544
- **Example:**
4562
+ Examples
4563
+ --------
4545
4564
4546
4565
.. plot:: mpl_examples/pylab_examples/arrow_demo.py
4547
4566
"""
0 commit comments