nwb-schema icon indicating copy to clipboard operation
nwb-schema copied to clipboard
verified publisher icon NeurodataWithoutBorders

Clarify documentation of IndexSeries

Open h-mayorquin opened this issue 11 months ago • 1 comments

The documentation of IndexSeries looks confusing to me in the sense that the case of indexing an ImageSeries and the static images of an Images container seem to be mixed in the explanation:

https://github.com/NeurodataWithoutBorders/nwb-schema/blob/d5a931d2cc0ae059d917705b7583136d756a2c8b/core/nwb.image.yaml#L178-L186

Are both cases supported? I can improve it to clarify that it can be used for both cases but I wanted to be sure.

h-mayorquin avatar Jan 28 '25 21:01 h-mayorquin

@h-mayorquin can you please create a PR to clarify the doc? We want to discourage the use of ImageSeries, and encourage the use of Images.

rly avatar Feb 20 '25 22:02 rly