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

[Documentation]: Link to NWBInspector from the validator #1530

Open
3 tasks done
oruebel opened this issue Aug 8, 2022 · 0 comments · Fixed by #1911
Open
3 tasks done

[Documentation]: Link to NWBInspector from the validator #1530

oruebel opened this issue Aug 8, 2022 · 0 comments · Fixed by #1911
Assignees
Labels
priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs issues related to documentation topic: validator issues related to validation of files

Comments

@oruebel
Copy link
Contributor

oruebel commented Aug 8, 2022

What would you like changed or added to the documentation and why?

The PyNWB validator checks for structural compliance of NWB files. In practice, however, most users should validate both structural compliance with the NWB schema as well as compliance of the data itself with NWB best practice. Users should, hence, be pointed to the NWBInspector, which runs both the PyNWB validator and additional data checks. To do this we should:

  1. Update the tutorial on Validating NWB Files to point to the nwbinspector
  2. Add a note to the the validator command line to to indicate that use of the NWBInspector is recommended
  3. Add a not to the docstring of the validate method to describe that the function only checks for compliance with the NWB schema and that users should use the NWBInspector for additional validation with NWB best practices.

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

@oruebel oruebel added topic: docs issues related to documentation topic: validator issues related to validation of files labels Aug 8, 2022
@oruebel oruebel changed the title [Documentation]: [Documentation]: Link to NWBInspector from the validator Aug 8, 2022
@stephprince stephprince added the priority: low alternative solution already working and/or relevant to only specific user(s) label Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs issues related to documentation topic: validator issues related to validation of files
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants