Reorder kwonly kwargs in Colorbar & related docs. #29652
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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);
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 fiddle
with the clip parameter.
timhoffm
reviewed
Feb 21, 2025
Comment on lines
+247
to
+248
| Other Parameters | ||
| ---------------- |
There was a problem hiding this comment.
It seems like numpydoc is placing the Attributes section between Parameters and Other Parameters, which I find quite confusing.
I propose not use Other 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.
timhoffm
approved these changes
Feb 22, 2025
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 22, 2025
timhoffm
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Feb 22, 2025
This prevents numpydoc from inserting Attributes between Parameters and Other Parameters see https://github .com/matplotlib/pull/29652#pullrequestreview-2634087106. It's also a pattern we generally use.
timhoffm
added a commit
that referenced
this pull request
Feb 22, 2025
…652-on-v3.10.x Backport PR #29652 on branch v3.10.x (Reorder kwonly kwargs in Colorbar & related docs.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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