Enhance 'age' parameter documentation #2161
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expanded documentation for the 'age' parameter to include age range examples and clarify usage.
Copied from https://nwbinspector.readthedocs.io/en/dev/best_practices/nwbfile_metadata.html#subject
Motivation
I received a question in a direct message: "I had a question about the age requirement for publishing to DANDI using NWB. If the user does not know the exact date of birth, can the user provide age as "3-8 months old" for the age of the subject during a given experiment? I've asked the researcher and he said that he doesn't record the date of birth since he doesn't view it as relevant for his experiments."
This could be better documented in pynwb, so I am adding that here. I will submit a separate PR for improving the schema doc.
How to test the behavior?
Checklist
ruff check . && codespellfrom the source directory.