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]: Add remaining best practice summaries for checks #502

Open
2 tasks done
CodyCBakerPhD opened this issue Sep 3, 2024 · 1 comment
Open
2 tasks done
Labels
priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs issues related to documentation

Comments

@CodyCBakerPhD
Copy link
Contributor

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

For a while now we've had 3 check functions link their best practices to an orphaned page (so that the links resolved without error): https://github.com/NeurodataWithoutBorders/nwbinspector/blob/dev/docs/best_practices/todo.rst

#501 removes that page and codes the best practices for those checks as explicitly 'TODO'

So someone should write a quick blurb about why those 3 checks are important

  1. https://github.com/NeurodataWithoutBorders/nwbinspector/pull/501/files#diff-613ecf43f4cc65aa2a2344c2074185a5c4a9a1eb32db3831b9dfa08df559c14eR56
  2. https://github.com/NeurodataWithoutBorders/nwbinspector/pull/501/files#diff-2f35eee2f078c767ada736ec7ee7860784b215294c67b88bd8c00a6a04884c1bR13
  3. https://github.com/NeurodataWithoutBorders/nwbinspector/pull/501/files#diff-0386a46bb72e66397ac6c0f1e34e341a666964d163c51171560a69b94ccc211eR48

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

Yes.

Code of Conduct

@CodyCBakerPhD CodyCBakerPhD added the topic: docs issues related to documentation label Sep 3, 2024
@stephprince stephprince added the priority: low alternative solution already working and/or relevant to only specific user(s) label Nov 6, 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
Projects
None yet
Development

No branches or pull requests

3 participants
@stephprince @CodyCBakerPhD and others