Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Reorder kwonly kwargs in Colorbar & related docs.#29652
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.
Conversation
Move "redundant" kwargs (cmap/norm can be specified via mappable;orientation/ticklocation can be specified via location) to the end ofthe kwarg list and under an "Other Parameters" section.Also remove mention of Normalize(clip=False); imshow(rand(10, 10), cmap=mpl.colormaps["viridis"].with_extremes(under="w", over="k")) colorbar(extend="both")seems enough to have over/under colors show up, i.e. no need to fiddlewith the clip parameter.
| Other Parameters | ||
| ---------------- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
It seems like numpydoc is placing theAttributes section betweenParameters andOther Parameters, which I find quite confusing.
I propose not useOther Parameters then here.
Edit: This is an intentional change in numpydoc 1.8 (numpy/numpydoc#571), though I'm not clear whether this effect was considered.
We can work around this by moving the parameters to the__init__ docstring, because that seems to be appended below the class docstring, see e.g.https://matplotlib.org/devdocs/api/widgets_api.html#matplotlib.widgets.Button. In a quick check, this seems to be a pattern we generally use.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'll merge this as is and do a follow-up to move the parameters to theinit docstring. That's logically simpler than reordering and moving at the same time.
efde717 intomatplotlib:mainUh oh!
There was an error while loading.Please reload this page.
This prevents numpydoc from inserting Attributes between Parameters andOther Parameters see https://github.com/matplotlib/pull/29652#pullrequestreview-2634087106.It's also a pattern we generally use.
…652-on-v3.10.xBackport PR#29652 on branch v3.10.x (Reorder kwonly kwargs in Colorbar & related docs.)
Move "redundant" kwargs (cmap/norm can be specified via mappable; orientation/ticklocation can be specified via location) to the end of the kwarg list and under an "Other Parameters" section.
Also remove mention of Normalize(clip=False);
seems enough to have over/under colors show up, i.e. no need to fiddle with the clip parameter.
PR summary
PR checklist