Repository navigation
Make functions param to secondary_x/yaxis not keyword-only. - #28133
QuLogic merged 1 commit into
Conversation
Sorry, something went wrong.
timhoffm
left a comment
There was a problem hiding this comment.
Ok. Stubs need to be updated.
Sorry, something went wrong.
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.
|
oops, done. |
Sorry, something went wrong.
|
Is an API change note worthwhile? If not, anyone can merge. |
Sorry, something went wrong.
|
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 .. versionchanged:: note in the function, so that a user could decide to write backward-compatible code. - But then again. I don't think, we have such information consistently. I would not bother. |
Sorry, something went wrong.
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 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.
PR summary
PR checklist