Skip to content
This repository has been archived by the owner on Nov 28, 2019. It is now read-only.

Make class docstrings available in gui? #64

Open
ceball opened this issue Aug 7, 2017 · 1 comment
Open

Make class docstrings available in gui? #64

ceball opened this issue Aug 7, 2017 · 1 comment

Comments

@ceball
Copy link
Member

ceball commented Aug 7, 2017

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
Copy link
Member

jbednar commented Aug 8, 2017

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!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants