{Check,Radio}Buttons: Improve docs of label_props#30412
{Check,Radio}Buttons: Improve docs of label_props#30412dstansby merged 2 commits intomatplotlib:mainfrom
Conversation
doronbehar
force-pushed
the
_Buttons--label_props.doc
branch
from
95c4dda to
5493009
Compare
dstansby
left a comment
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.
doronbehar
force-pushed
the
_Buttons--label_props.doc
branch
from
5493009 to
f7376b1
Compare
|
Not sure if we want to roll it into here or do it separately, but looks like the type hint for 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 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. |
|
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. |
doronbehar
force-pushed
the
_Buttons--label_props.doc
branch
from
d6073f1 to
0ef0da4
Compare
doronbehar
force-pushed
the
_Buttons--label_props.doc
branch
from
0ef0da4 to
2e10b79
Compare
…412-on-v3.10.x Backport PR #30412 on branch v3.10.x ({Check,Radio}Buttons: Improve docs of label_props)
4 participants
PR summary
Mostly addresses #30393. One may argue the API is still inconsistent, but at least it is documented now.
PR checklist