{Check,Radio}Buttons: Improve docs of label_props - #30412
Conversation
Sorry, something went wrong.
dstansby
left a comment
There was a problem hiding this comment.
Thanks - this looks good now. There's a couple of links that need fixing though, I think (but haven't tested) that my inline suggestions to reference the classes instead of __init__ should work.
Sorry, something went wrong.
|
Not sure if we want to roll it into here or do it separately, but looks like the type hint for label_props should also be updated. matplotlib/lib/matplotlib/widgets.pyi Line 211 in 77a16b9 That type hint was based on reading the docstring, but it is clear from the code that Sequence/list was not actually a viable input to this parameter. (Namely, there is a check_is_instance for dict/None) That was the one change that flagged to me as "oh, this is actually changing the documented type, we should be sure of that" and upon looking, I agree with the new version, just looking to keep the type hints in sync if we can. |
Sorry, something went wrong.
|
Thanks for noticing this @ksunden. I think it is appropriate to fix this in this PR too - type hints are sort of a documentation. Pushed a fix. |
Sorry, something went wrong.
…412-on-v3.10.x Backport PR #30412 on branch v3.10.x ({Check,Radio}Buttons: Improve docs of label_props)
PR summary
Mostly addresses #30393. One may argue the API is still inconsistent, but at least it is documented now.
PR checklist