Skip to content

DOC: Clarify that parameters to gridded data plotting functions are p… - #28054

Merged
timhoffm merged 1 commit into
matplotlib:mainfrom
timhoffm:pos-only
Apr 10, 2024
Merged

timhoffm merged 1 commit into
matplotlib:mainfrom
timhoffm:pos-only

Conversation

@timhoffm

Copy link
Copy Markdown
Member

…ositional-only

Closes #28047 and the already closed #11526.

This introduces the positional-only marker / into the call signatures (pcolorfast already had it). While IIRC I originally opted against adding it for simplicity, the above issues show that this is not clear enough. It's helpful for experienced people and I believe it does not distract people who don't know what it is too much because it's here always at the end before **kwargs.

Additionally, it does not hurt to spell it out in text as well.

…ositional-only

Closes matplotlib#28047 and the already closed matplotlib#11526.

This introduces the positional-only marker `/` into the call
signatures (`pcolorfast` already had it). While IIRC I originally
opted against adding it for simplicity, the above issues show that
this is not clear enough. It's helpful for experienced people and
I believe it does not distract people who don't know what it is too
much because it's here always at the end before **kwargs.

Additionally, it does not hurt to spell it out in text as well.
@timhoffm timhoffm added this to the v3.10.0 milestone Apr 10, 2024

@tacaswell tacaswell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can self-merge on green

@timhoffm
timhoffm merged commit 2360c59 into matplotlib:main Apr 10, 2024
@timhoffm
timhoffm deleted the pos-only branch April 10, 2024 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

2 participants