Clarify planar_contour

catalystneuro · Jun 1, 2024 · 243ae09 · 243ae09
1 parent 0dc40d7
commit 243ae09
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/spec/ndx-extracellular-channels.extensions.yaml b/spec/ndx-extracellular-channels.extensions.yaml
@@ -108,8 +108,8 @@ groups:
       - 2
     - - null
       - 3
-    doc: The coordinates of the nodes of the polygon that describe the shape (contour) of the probe,
-      e.g., [(-20, -30), (20, -110), (60, -30), (60, 190), (-20, 190)].
+    doc: The coordinates of the nodes of the polygon that describe the shape (contour)
+      of the probe, e.g., [(-20, -30), (20, -110), (60, -30), (60, 190), (-20, 190)].
     attributes:
     - name: unit
       dtype: text

diff --git a/src/spec/create_extension_spec.py b/src/spec/create_extension_spec.py
@@ -165,7 +165,8 @@ def main():
         datasets=[
             NWBDatasetSpec(  # TODO should this be an attribute?
                 name="planar_contour",  # TODO should this just be "contour"?
-                doc="The planar polygon that outlines the probe contour.",
+                doc=("The coordinates of the nodes of the polygon that describe the shape (contour) of the probe, "
+	                 "e.g., [(-20, -30), (20, -110), (60, -30), (60, 190), (-20, 190)]."),
                 dtype="float",
                 dims=[["num_points", "x"], ["num_points", "x, y"], ["num_points", "x, y, z"]],
                 shape=[[None, 1], [None, 2], [None, 3]],