DOC: formatting fixes to mplot3d #12033
Conversation
| ---------- | ||
| X, Y, Z : array-like | ||
| The x, y and z coordinates of the arrow locations (default is | ||
| tail of arrow; see *pivot* kwarg) |
There was a problem hiding this comment.
I haven't and don't intend to touch any of these descriptions - my goal was only to switch to using Parameters
| quiver(X, Y, Z, U, V, W, **kwargs) | ||
|
|
||
| Arguments: | ||
| ax.quiver(X, Y, Z, U, V, W, /, length=1, arrow_length_ratio=.3, pivot='tail', normalize=False, **kwargs) |
There was a problem hiding this comment.
This replaces the signature in the docs, using the PEP570 syntax. There's precedent in ax.voxels, but it was admittedly set by me.
There was a problem hiding this comment.
I did not look a the code, but if this is like Axes.quiver() this is technically not correct, because you can leave out some of the positional arguments. This is not something one can encode in a single signature line. We therefore use a "Call signatures" block. See the docs of Axes.quiver
There was a problem hiding this comment.
All 6 arguments are required to Axes3D.quiver:
# handle args
argi = 6
if len(args) < argi:
raise ValueError('Wrong number of arguments. Expected %d got %d' %
(argi, len(args)))https://matplotlib.org/devel/documenting_mpl.html doesn't have any mention of "Call signatures" - perhaps it would be worth adding.
There was a problem hiding this comment.
If that doc signature is correct, we could directly change the signature of the function to be explicit. But if you don't want to go into this, that's fine as well.
There was a problem hiding this comment.
Until PEP570 is implemented, that would involve change the function signature to allow X to be passed by keyword. I think requiring it to be positional is a good idea.
|
|
||
| *U*, *V*, *W*: | ||
| The x, y and z components of the arrow vectors | ||
| Plot a 3D field of arrows. | ||
|
|
||
| The arguments could be array-like or scalars, so long as they |
There was a problem hiding this comment.
probably should add The arguments *X*, *Y*, *Z*, *U*, *V*, *W* because the context above is deleted.
| ---------- | ||
| X, Y, Z : array-like | ||
| The x, y and z coordinates of the arrow locations (default is | ||
| tail of arrow; see *pivot* kwarg) |
quiverseemed to be doing its own thing here