[Documentation]: Show how to use dandi config when calling nwbinspector library

[rly]

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

The docs page for using the nwbinspector library does not show how to run the inspector with the internal DANDI config. I think that would be useful. After some digging, I believe it is just:

from nwbinspector import inspect_nwbfile, load_config

dandi_config = load_config("dandi")
messages = list(inspect_nwbfile(nwbfile_path=nwb_path, config=dandi_config))

But let me know if I am missing something or there is an easier way.

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

Yes.

Code of Conduct

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

[stephprince]

That is the easiest approach that I am aware of. The other option is using the CLI where it would be:

nwbinspector nwb_path --config dandi

I agree it would be great to add that information to the documentation, including an explanation of when to use the dandi config and any important differences between the dandi config and the default.

Related issue: #360