Make class docstrings available in gui?

ioam / paramnb

Generate ipywidgets from Parameterized objects in the notebook

BSD 3-Clause "New" or "Revised" License

36 stars 10 forks source link

Make class docstrings available in gui? #64

Open ceball opened 7 years ago

ceball commented 7 years ago

Nowhere in paramnb is the class docstring displayed. In a notebook you can always do e.g. Class?? to see Class's docstring, but it might be nice (particularly when choosing objects in a dropdown) to be able to see the docstring in the gui.

jbednar commented 7 years ago

I agree that would be helpful. We have to be careful, because class docstrings can get very long, and if we display them when hovering it's possible to make the interface unusable by covering up important info. As long as we do it well, it would be great to have this!