8000 update axes.arrow() and patches.FancyArrow documentation by kaufman · Pull Request #941 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

update axes.arrow() and patches.FancyArrow documentation #941

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 13, 2012
Merged

update axes.arrow() and patches.FancyArrow documentation #941

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e3a8bb
update axes.arrow() and patches.FancyArrow documentation
kaufman Jun 10, 2012
18ca812
add sphinx markup to documentation
kaufman Jun 11, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
add sphinx markup to documentation 
	modified:   lib/matplotlib/patches.py
  • Loading branch information
@kaufman
kaufman committed Jun 11, 2012
commit 18ca8126d9e506f0fef0a93ef04343f6e16a0b20
16 changes: 8 additions & 8 deletions lib/matplotlib/patches.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -920,30 +920,30 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False, \
head_starts_at_zero=False,**kwargs):
"""
Constructor arguments
width: float (default: 0.001)
*width*: float (default: 0.001)
width of full arrow tail

length_includes_head: [True | False] (default: False)
*length_includes_head*: [True | False] (default: False)
True if head is to be counted in calculating the length.

head_width: float or None (default: 3*width)
*head_width*: float or None (default: 3*width)
total width of the full arrow head

head_length: float or None (default: 1.5 * head_width)
*head_length*: float or None (default: 1.5 * head_width)
length of arrow head

shape: ['full', 'left', 'right'] (default: 'full')
*shape*: ['full', 'left', 'right'] (default: 'full')
draw the left-half, right-half, or full arrow

overhang: float (default: 0)
*overhang*: float (default: 0)
fraction that the arrow is swept back (0 overhang means
triangular shape). Can be negative or greater than one.

head_starts_at_zero: [True | False] (default: False)
*head_starts_at_zero*: [True | False] (default: False)
if True, the head starts being drawn at coordinate 0
instead of ending at coordinate 0.

Other valid kwargs (inherited from Patch) are:
Other valid kwargs (inherited from :class:`Patch`) are:
%(Patch)s

"""
Expand Down
0