[Documentation]: Tutorials following best practices specified by the NWBInspector

[oruebel]

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

The following issue raised on PyNWB NeurodataWithoutBorders/pynwb#1628 I believe is also relevant for MatNWB.

Proposed Enhancement Enhance the test suite for the tutorials to run the NWBInspector on all files created by the tutorials to ensure that the files created by the tutorials follow best practices.

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

No.

Code of Conduct

• I agree to follow this project's Code of Conduct
• Have you ensured this change was not already requested?

[ehennestad]

@oruebel Would you suggest to use Importance level 0, 1 or 2 as a threshold for test failure?

class Importance(Enum):
    """A definition of the valid importance levels for a given check function."""

    ERROR = 4
    PYNWB_VALIDATION = 3
    CRITICAL = 2
    BEST_PRACTICE_VIOLATION = 1
    BEST_PRACTICE_SUGGESTION = 0

https://github.com/NeurodataWithoutBorders/nwbinspector/blob/c26924b89c8cbcd35a6e70ae04a5fc323d4bd92b/src/nwbinspector/_types.py#L8-L15