Remove quantity from OptogeneticStimulusSite and ImagingPlane definitions #472
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.
The group spec that defines
OptogeneticStimulusSite
includesquantity: '*'
. What does that mean? To useOptogeneticStimulusSite
, one would either:neurodata_type_def: X
,neurodata_type_inc: OptogeneticStimulusSite
neurodata_type_inc: OptogeneticStimulusSite
neurodata_type_inc: NWBContainer or another parent type
In all cases, one would set
quantity
to a value or leave it out, in which case it would be set to the default GroupSpec quantity value of 1 (or should it inherit from the data type definition? But why would you want to set it on the data type definition so that it applies to every use of it?)If
OptogeneticStimulusSite
were defined nested within another data type, thenquantity
would be used, but here it is defined at the root of the schema.The same is true for
ImagingPlane
which hasquantity: '*'
. Both are used only as subgroups withquantity: '*'
and as the target type for links with default quantity (1).Since the
quantity
on the data type definition is not actually used and has no bearing on the quantity when it is used, it should be removed to reduce confusion. Not definingquantity
on a non-nested data type definition should be added as a best practice to writing schema.