Better documentation for tooltips from docstrings

Open psobolewskiPhD opened this issue 8 months ago • 3 comments

https://github.com/pyapp-kit/magicgui/pull/100 added a pretty amazing feature of generating tooltips from docstrings, but it's not really documented, just mentioned in code in a single example? https://pyapp-kit.github.io/magicgui/generated_examples/basic_widgets_demo/#basic-widgets-demo

Jun 13 '25 21:06 psobolewskiPhD

would heartily welcome a docs PR anywhere you see fit. let me know if it's unclear how to get it where you'd like to see it

Jun 14 '25 00:06 tlambert03

Any thoughts on where to best fit a short description? Is it worth it's own thing under Usage? "Docstrings to Tooltips"?

Jun 15 '25 02:06 psobolewskiPhD

well, since this feature only applies to FunctionGui (i.e. the return type of the @magicgui decorator) then a section on https://pyapp-kit.github.io/magicgui/decorators/ would make sense. And perhaps also the FunctionGui class docstring should be expanded as well

Jun 15 '25 17:06 tlambert03