Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tooltips to test parameters on test creation page #361

Open
gidili opened this issue Jul 31, 2019 · 2 comments
Open

Add tooltips to test parameters on test creation page #361

gidili opened this issue Jul 31, 2019 · 2 comments

Comments

@gidili
Copy link
Member

gidili commented Jul 31, 2019

From @rgerkin: When creating tests, it isn't obvious what some of the parameters mean. I'd like to have tooltips there. Where could I put these in the corresponding NeuronUnit code? Could they be fields in the schema that SciDash could use to generate tooltips?

@gidili
Copy link
Member Author

gidili commented Jul 31, 2019

This is straightforward if we add tooltips on the NeuronUnit side and the best place would be to keep the tooltips together with the schema as an extra field that then can be propagated to the UI alongside with the other stuff and adding the tooltip itself at that point is trivial.

@rgerkin
Copy link
Collaborator

rgerkin commented Dec 6, 2019

There is an open issue in (scidash/sciunit#84) about formalizing docstrings, and HBP is collaborating with me on figuring this out. The result will be docstrings for every test which can be easily parsed (e.g. with Sphinx) to generate the content of these tooltip.

So I would make this very generic for now, e.g. SciDash calls Test.get_definition(param_name), and I implement that in a simple way for now (e.g. manually for one test), and the tooltip shows if the return value of that method is non-empty. Then later I can implement get_definition correctly to lookup from docstrings, and be able to expect that SciDash will show the new, informative tooltips for all tests with proper docstrings.

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

No branches or pull requests

4 participants