From 243ae097b0cf95c733b2b1d5e244db86fde4f6a0 Mon Sep 17 00:00:00 2001 From: rly Date: Fri, 31 May 2024 23:48:33 -0700 Subject: [PATCH] Clarify planar_contour --- spec/ndx-extracellular-channels.extensions.yaml | 4 ++-- src/spec/create_extension_spec.py | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/spec/ndx-extracellular-channels.extensions.yaml b/spec/ndx-extracellular-channels.extensions.yaml index 9fdd24c..db05ae7 100644 --- 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 index 693b091..00347eb 100644 --- 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]],