Merge branch 'master' into update_template

Author: rly

README.md

@@ -85,7 +85,7 @@ Representation of a probe in NWB.
 - **probe_type**  `string`: type of probe
 - **units**  `string`: units in device
 - **probe_description**  `string`: description of probe
-- **contact_side_numbering**  `bool`: is contact_side_numbering enabled
+- **contact_side_numbering**  `bool`: Whether the electrodes were numbered in a scheme wherein the contacts were electrodes facing up toward the viewer (true) or if the numbering was based on the electrodes facing down (false). This is relevant when the goal is to determine where in the tissue each electrode contact is located. (optional)
 - **contact_size**  `float`: value of contact size as float
 - **shanks**  `dict`: shanks in the probe
 

spec/ndx-franklab-novela.extensions.yaml

@@ -44,7 +44,12 @@ groups:
     doc: description of the probe
   - name: contact_side_numbering
     dtype: bool
-    doc: is contact_side_numbering enabled
+    doc: Whether the electrodes were numbered in a scheme wherein the contacts
+      were electrodes facing up toward the viewer (true) or if the numbering was
+      based on the electrodes facing down (false). This is relevant when the
+      goal is to determine where in the tissue each electrode contact is
+      located.
+    required: false
   - name: contact_size
     dtype: float
     doc: value of contact size in float

src/spec/create_extension_spec.py

@@ -58,7 +58,17 @@ def main():
             NWBAttributeSpec(name="probe_type", doc="type of the probe", dtype="text"),
             NWBAttributeSpec(name="units", doc="units in probe, acceptable values um or mm", dtype="text"),
             NWBAttributeSpec(name="probe_description", doc="description of the probe", dtype="text"),
-            NWBAttributeSpec(name="contact_side_numbering", doc="is contact_side_numbering enabled", dtype="bool"),
+            NWBAttributeSpec(
+                name="contact_side_numbering",
+                doc=(
+                    "Whether the electrodes were numbered in a scheme wherein the contacts were "
+                    "electrodes facing up toward the viewer (true) or if the numbering was based "
+                    "on the electrodes facing down (false). This is relevant when the goal is to "
+                    "determine where in the tissue each electrode contact is located."
+                ),
+                dtype="bool",
+                required=False,
+            ),
             NWBAttributeSpec(name="contact_size", doc="value of contact size in float", dtype="float"),
         ],
     )