8000 Merge pull request #12033 from eric-wieser/__signature__-docs · matplotlib/matplotlib@0b84ecb · GitHub
[go: up one dir, main page]

Skip to content

Commit 0b84ecb

Browse files
authored
Merge pull request #12033 from eric-wieser/__signature__-docs
DOC: formatting fixes to mplot3d
2 parents f1f66b0 + 8bfbb8d commit 0b84ecb

File tree

1 file changed

+29
-32
lines changed

1 file changed

+29
-32
lines changed

lib/mpl_toolkits/mplot3d/axes3d.py

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2402,8 +2402,9 @@ def bar3d(self, x, y, z, dx, dy, dz, color=None,
24022402
When true, this shades the dark sides of the bars (relative
24032403
to the plot's source of light).
24042404
2405-
Any additional keyword arguments are passed onto
2406-
:func:`~mpl_toolkits.mplot3d.art3d.Poly3DCollection`
2405+
**kwargs
2406+
Any additional keyword arguments are passed onto
2407+
:class:`~mpl_toolkits.mplot3d.art3d.Poly3DCollection`
24072408
24082409
Returns
24092410
-------
@@ -2483,49 +2484,45 @@ def quiver(self, *args,
24832484
length=1, arrow_length_ratio=.3, pivot='tail', normalize=False,
24842485
**kwargs):
24852486
"""
2486-
Plot a 3D field of arrows.
2487-
2488-
call signatures::
2489-
2490-
quiver(X, Y, Z, U, V, W, **kwargs)
2491-
2492-
Arguments:
2487+
ax.quiver(X, Y, Z, U, V, W, /, length=1, arrow_length_ratio=.3, pivot='tail', normalize=False, **kwargs)
24932488
2494-
*X*, *Y*, *Z*:
2495-
The x, y and z coordinates of the arrow locations (default is
2496-
tail of arrow; see *pivot* kwarg)
2497-
2498-
*U*, *V*, *W*:
2499-
The x, y and z components of the arrow vectors
2489+
Plot a 3D field of arrows.
25002490
25012491
The arguments could be array-like or scalars, so long as they
25022492
they can be broadcast together. The arguments can also be
25032493
masked arrays. If an element in any of argument is masked, then
25042494
that corresponding quiver element will not be plotted.
25052495
2506-
Keyword arguments:
2496+
Parameters
2497+
----------
2498+
X, Y, Z : array-like
2499+
The x, y and z coordinates of the arrow locations (default is
2500+
tail of arrow; see *pivot* kwarg)
25072501
2508-
*length*: [1.0 | float]
2509-
The length of each quiver, default to 1.0, the unit is
2510-
the same with the axes
2502+
U, V, W : array-like
2503+
The x, y and z components of the arrow vectors
25112504
2512-
*arrow_length_ratio*: [0.3 | float]
2513-
The ratio of the arrow head with respect to the quiver,
2514-
default to 0.3
2505+
length : float
2506+
The length of each quiver, default to 1.0, the unit is
2507+
the same with the axes
25152508
2516-
*pivot*: [ 'tail' | 'middle' | 'tip' ]
2517-
The part of the arrow that is at the grid point; the arrow
2518-
rotates about this point, hence the name *pivot*.
2519-
Default is 'tail'
2509+
arrow_length_ratio : float
2510+
The ratio of the arrow head with respect to the quiver,
2511+
default to 0.3
25202512
2521-
*normalize*: bool
2522-
When True, all of the arrows will be the same length. This
2523-
defaults to False, where the arrows will be different lengths
2524-
depending on the values of u,v,w.
2513+
pivot : {'tail', 'middle', 'tip'}
2514+
The part of the arrow that is at the grid point; the arrow
2515+
rotates about this point, hence the name *pivot*.
2516+
Default is 'tail'
25252517
2526-
Any additional keyword arguments are delegated to
2527-
:class:`~matplotlib.collections.LineCollection`
2518+
normalize : bool
2519+
When True, all of the arrows will be the same length. This
2520+
defaults to False, where the arrows will be different lengths
2521+
depending on the values of u,v,w.
25282522
2523+
**kwargs
2524+
Any additional keyword arguments are delegated to
2525+
:class:`~matplotlib.collections.LineCollection`
25292526
"""
25302527
def calc_arrow(uvw, angle=15):
25312528
"""

0 commit comments

Comments
 (0)
0