Make functions param to secondary_x/yaxis not keyword-only.#28133
Merged
QuLogic merged 1 commit intomatplotlib:mainfrom Apr 25, 2024
Merged
Make functions param to secondary_x/yaxis not keyword-only.#28133QuLogic merged 1 commit intomatplotlib:mainfrom
functions param to secondary_x/yaxis not keyword-only.#28133QuLogic merged 1 commit intomatplotlib:mainfrom
Conversation
timhoffm
approved these changes
Apr 24, 2024
Member
timhoffm
left a comment
There was a problem hiding this comment.
Ok. Stubs need to be updated.
I suspect the parameter was made keyword-only because the originally planned signature was `secondary_xaxis(location, forward=..., inverse=...)` where the keywords actually add some semantics (though that signature overall seems worse); however, for a single `functions` parameter, having to type an extra `functions=` in the call doesn't help the reader much (either they know what secondary_x/yaxis does, in which case the explicit kwarg doesn't matter, or they don't, in which case the kwarg name hardly helps)... and is a bit annoying. See the modified gallery entry, for example.
Contributor
Author
|
oops, done. |
oscargus
approved these changes
Apr 25, 2024
Member
|
Is an API change note worthwhile? If not, anyone can merge. |
Member
|
An API change note is not neccessary since we're only relaxing the API. It's also not very helpful: Nobody will read through API changes, see this and take an action ("Finally, this is not kwonly anymore - I go through my code and change to positional use" is not gonna happen). So the note would mostly be noise. The only possible benefit would be a |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
I suspect the parameter was made keyword-only because the originally planned signature (#11859) was
secondary_xaxis(location, forward=..., inverse=...)where the keywords actually add some semantics (though that signature overall seems worse); however, for a singlefunctionsparameter, having to type an extrafunctions=in the call doesn't help the reader much (either they know what secondary_x/yaxis does, in which case the explicit kwarg doesn't matter, or they don't, in which case the kwarg name hardly helps)... and is a bit annoying. See the modified gallery entry, for example.PR summary
PR checklist