Merge pull request #20 from SpikeInterface/correct-spec-units

Few modifications to spec descriptions

Author: khl02007

spec/ndx-probeinterface.extensions.yaml

@@ -59,7 +59,7 @@ groups:
       - 2
     - - null
       - 3
-    doc: dimension of the probe
+    doc: position of the contact
   - name: contact_shape
     neurodata_type_inc: VectorData
     dtype: text
@@ -91,25 +91,25 @@ groups:
     - - null
       - 2
       - 3
-    doc: dimension of the probe
+    doc: the axes defining the contact plane
     quantity: '?'
   - name: radius
     neurodata_type_inc: VectorData
     dtype: float
-    doc: Radius of a circular contact
+    doc: radius of a circular contact
     quantity: '?'
   - name: width
     neurodata_type_inc: VectorData
     dtype: float
-    doc: Width of a rectangular or square contact
+    doc: width of a rectangular or square contact
     quantity: '?'
   - name: height
     neurodata_type_inc: VectorData
     dtype: float
-    doc: Height of a rectangular contact
+    doc: height of a rectangular contact
     quantity: '?'
   - name: device_channel_index_pi
     neurodata_type_inc: VectorData
     dtype: int
-    doc: ID of the channel connected to the contact
+    doc: index of the channel connected to the contact
     quantity: '?'

src/spec/create_extension_spec.py

@@ -30,7 +30,7 @@ def main():
         datasets=[
             NWBDatasetSpec(
                 name="contact_position",
-                doc="dimension of the probe",
+                doc="position of the contact",
                 dtype="float",
                 dims=[["num_contacts", "x, y"], ["num_contacts", "x, y, z"]],
                 shape=[[None, 2], [None, 3]],
@@ -58,7 +58,7 @@ def main():
             ),
             NWBDatasetSpec(
                 name="contact_plane_axes",
-                doc="dimension of the probe",
+                doc="the axes defining the contact plane",
                 dtype="float",
                 dims=[["num_contacts", "v1, v2", "x,y"], ["num_contacts", "v1,v2", "x, y, z"]],
                 shape=[[None, 2, 2], [None, 2, 3]],
@@ -67,28 +67,28 @@ def main():
             ),
             NWBDatasetSpec(
                 name="radius",
-                doc="Radius of a circular contact",
+                doc="radius of a circular contact",
                 dtype="float",
                 neurodata_type_inc="VectorData",
                 quantity="?",
             ),
             NWBDatasetSpec(
                 name="width",
-                doc="Width of a rectangular or square contact",
+                doc="width of a rectangular or square contact",
                 dtype="float",
                 neurodata_type_inc="VectorData",
                 quantity="?",
             ),
             NWBDatasetSpec(
                 name="height",
-                doc="Height of a rectangular contact",
+                doc="height of a rectangular contact",
                 dtype="float",
                 neurodata_type_inc="VectorData",
                 quantity="?",
             ),
             NWBDatasetSpec(
                 name="device_channel_index_pi",
-                doc="ID of the channel connected to the contact",
+                doc="index of the channel connected to the contact",
                 dtype="int",
                 neurodata_type_inc="VectorData",
                 quantity="?",