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

[Feature]: Ensure Human-Readable Validation Messages #812

Closed
garrettmflynn opened this issue May 29, 2024 · 2 comments
Closed

[Feature]: Ensure Human-Readable Validation Messages #812

garrettmflynn opened this issue May 29, 2024 · 2 comments
Labels
enhancement New feature or request priority: low

Comments

@garrettmflynn
Copy link
Member

What would you like to see added to the NWB GUIDE?

The messages rendered from the NWB Inspector should clearly indicate how to update the GUIDE to resolve the issue. In particular, the Institution and Keywords messages are not the simplest to understand—though it is technically possible to identify where to look from the message.

Screenshot 2024-05-29 at 2 14 50 PM

We should come up with a robust strategy for providing GUIDE-side recommendations—or simply tweaking the rendering—so users are presented with clear instructions when certain issues like this come up.

Do you have any interest in helping implement the feature?

Yes.

Code of Conduct

Yes

Did you confirm this feature was not already reported?

Yes

@garrettmflynn garrettmflynn added the enhancement New feature or request label May 29, 2024
@CodyCBakerPhD
Copy link
Collaborator

The easiest thing for us to do would probably be a rewrite of Inspector messages to indicate how to fix them with lower cognitive burden

@CodyCBakerPhD
Copy link
Collaborator

This will be tackled during the upcoming NWB Inspector refactor with Steph

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority: low
Projects
None yet
Development

No branches or pull requests

2 participants