8000 Some more doc fixes for quiver.py · bbasseri/matplotlib@8ebc370 · GitHub
[go: up one dir, main page]

Skip to content

Commit 8ebc370

Browse files
committed
Some more doc fixes for quiver.py
1 parent 713e0bc commit 8ebc370

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

lib/matplotlib/quiver.py

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@
6363
6464
Keyword arguments:
6565
66-
*units*: [ 'width' | 'height' | 'dots' | 'inches' | 'x' | 'y' | 'xy']
67-
arrow units; the arrow dimensions *except for length* are in
66+
*units*: [ 'width' | 'height' | 'dots' | 'inches' | 'x' | 'y' | 'xy' ]
67+
Arrow units; the arrow dimensions *except for length* are in
6868
multiples of this unit.
6969
7070
* 'width' or 'height': the width or height of the axes
@@ -81,7 +81,7 @@
8181
for 'dots' or 'inches', resizing does not change the arrows.
8282
8383
84-
*angles*: [ 'uv' | 'xy' | array]
84+
*angles*: [ 'uv' | 'xy' | array ]
8585
With the default 'uv', the arrow aspect ratio is 1, so that
8686
if *U*==*V* the angle of the arrow on the plot is 45 degrees
8787
CCW from the *x*-axis.
@@ -90,13 +90,13 @@
9090
of values in degrees, CCW from the *x*-axis.
9191
9292
*scale*: [ *None* | float ]
93-
data units per arrow length unit, e.g. m/s per plot width; a smaller
93+
Data units per arrow length unit, e.g. m/s per plot width; a smaller
9494
scale parameter makes the arrow longer. If *None*, a simple
9595
autoscaling algorithm is used, based on the average vector length
9696
and the number of vectors. The arrow length unit is given by
9797
the *scale_units* parameter
9898
99-
*scale_units*: *None*, or any of the *units* options.
99+
*scale_units*: *None*, or any of the *units* options.
100100
For example, if *scale_units* is 'inches', *scale* is 2.0, and
101101
``(u,v) = (1,0)``, then the vector will be 0.5 inches long.
102102
If *scale_units* is 'width', then the vector will be half the width
@@ -108,26 +108,26 @@
108108
"angles='xy', scale_units='xy', scale=1".
109109
110110
*width*:
111-
shaft width in arrow units; default depends on choice of units,
111+
Shaft width in arrow units; default depends on choice of units,
112112
above, and number of vectors; a typical starting value is about
113113
0.005 times the width of the plot.
114114
115115
*headwidth*: scalar
116-
head width as multiple of shaft width, default is 3
116+
Head width as multiple of shaft width, default is 3
117117
118118
*headlength*: scalar
119-
head length as multiple of shaft width, default is 5
119+
Head length as multiple of shaft width, default is 5
120120
121121
*headaxislength*: scalar
122-
head length at shaft intersection, default is 4.5
122+
Head length at shaft intersection, default is 4.5
123123
124124
*minshaft*: scalar
125-
length below which arrow scales, in units of head length. Do not
125+
Length below which arrow scales, in units of head length. Do not
126126
set this to less than 1, or small arrows will look terrible!
127127
Default is 1
128128
129129
*minlength*: scalar
130-
minimum length as a multiple of shaft width; if an arrow length
130+
Minimum length as a multiple of shaft width; if an arrow length
131131
is less than this, plot a dot (hexagon) of this diameter instead.
132132
Default is 1.
133133
@@ -173,7 +173,7 @@
173173
The length of the key
174174
175175
*label*:
176-
a string with the length and units of the key
176+
A string with the length and units of the key
177177
178178
Keyword arguments:
179179
@@ -217,8 +217,7 @@
217217

218218

219219
class QuiverKey(martist.Artist):
220-
""" Labelled arrow for use as a quiver plot scale key.
221-
"""
220+
""" Labelled arrow for use as a quiver plot scale key."""
222221
halign = {'N': 'center', 'S': 'center', 'E': 'left', 'W': 'right'}
223222
valign = {'N': 'bottom', 'S': 'top', 'E': 'center', 'W': 'center'}
224223
pivot = {'N': 'mid', 'S': 'mid', 'E': 'tip', 'W': 'tail'}

0 commit comments

Comments
 (0)
0