Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
[WIP] DOC Updated documentation of arrow function to numpy docs format.#7029
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
62bcf04
ac0f466
b6c49e4
5ed7809
a008555
ee5953a
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -4522,13 +4522,34 @@ def arrow(self, x, y, dx, dy, **kwargs): | ||
""" | ||
Add an arrow to the axes. | ||
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 | ||
Other Parameters | ||
----------------- | ||
Optional kwargs (inherited from FancyArrow patch) control the arrow | ||
construction and properties: | ||
%(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 | ||
@@ -4537,13 +4558,11 @@ def arrow(self, x, y, dx, dy, **kwargs): | ||
ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0), | ||
arrowprops=dict(arrowstyle="->")) | ||
Examples | ||
-------- | ||
.. plot:: mpl_examples/pylab_examples/arrow_demo.py | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Can you please add a blank line after this? I am not entirely sure why, but python3.5 is unhappy… There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Sorry, I wasn't clear: I meant after the ".. plot::" directive. | ||
""" | ||
# Strip away units for the underlying patch since units | ||
# do not make sense to most patch-like code | ||