Merge branch 'dev' into enh/improve_electrodes_docs

NeurodataWithoutBorders · Apr 21, 2022 · 9b73c7f · 9b73c7f
2 parents c7fc516 + 150157b
commit 9b73c7f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/core/nwb.icephys.yaml b/core/nwb.icephys.yaml
@@ -199,6 +199,10 @@ groups:
   neurodata_type_inc: NWBContainer
   doc: An intracellular electrode and its metadata.
   datasets:
+  - name: cell_id
+    dtype: text
+    doc: unique ID of the cell
+    quantity: '?'
   - name: description
     dtype: text
     doc: Description of electrode (e.g.,  whole-cell, sharp, etc.).

diff --git a/core/nwb.ophys.yaml b/core/nwb.ophys.yaml
@@ -217,7 +217,7 @@ groups:
       default_value: 1.0
       doc: Scalar to multiply each element in data to convert it to the specified 'unit'.
         If the data are stored in acquisition system units or other units
-        that require a conversion to be interpretable, multiply the data by 'conversion' and add 'offset'
+        that require a conversion to be interpretable, multiply the data by 'conversion'
         to convert the data to the specified 'unit'. e.g. if the data acquisition system
         stores values in this object as pixels from x = -500 to 499, y = -500 to 499
         that correspond to a 2 m x 2 m range, then the 'conversion' multiplier to get

diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
@@ -9,11 +9,12 @@ Release Notes
 Minor changes
 ^^^^^^^^^^^^^
 - Added an ``offset`` attribute to all ``TimeSeries`` objects to allow enhanced translation to scientific units.
-- Clarified the doc string for the `reference` column of the electrodes table.
+- Clarified the doc string for the ``reference`` column of the electrodes table. (#498)
+- Added ``cell_id`` field to ``IntracellularElectrode``. (#512)
 
 Major changes
 ^^^^^^^^^^^^^
-- Shape of SpatialSeries.data is more restrictive to prevent > 3 columns.
+- Shape of SpatialSeries.data is more restrictive to prevent > 3 columns. (#510)
 
 
 2.4.0 (Aug. 11, 2021)