Clarify Images.order_of_images doc (#519)

NeurodataWithoutBorders · May 19, 2022 · adcf428 · adcf428
1 parent 3316da7
commit adcf428
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/core/nwb.base.yaml b/core/nwb.base.yaml
@@ -254,4 +254,6 @@ groups:
       target_type: Image
       reftype: object
     doc: Ordered dataset of references to Image objects stored in the parent group.
+      Each Image object in the Images group should be stored once and only once, so
+      the dataset should have the same length as the number of images.
     quantity: '?'
diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
@@ -16,7 +16,7 @@ Minor changes
 - Allowed ``NWBFile/stimulus/templates`` to contain ``Images`` objects. (#459)
 - Added new optional "order_of_images" dataset to ``Images`` that contains an ordered list of object references to
   ``Image`` objects stored in the same ``Images`` object. This dataset must be used if the images are referred to
-  by index, e.g., from an ``IndexSeries`` object. (#459, #518)
+  by index, e.g., from an ``IndexSeries`` object. (#459, #518, #519)
 - Overhauled ``IndexSeries`` type (#459):
   - Fixed dtype of ``data`` dataset of ``IndexSeries`` (int32 -> uint32).
   - Updated ``unit`` attribute of ``data`` to have fixed value "N/A".