Improve documentation for some electrodes table columns (#498)

Co-authored-by: Ben Dichter <ben.dichter@gmail.com>
NeurodataWithoutBorders · Apr 21, 2022 · 4cc938f · 4cc938f
1 parent 150157b
commit 4cc938f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/core/nwb.file.yaml b/core/nwb.file.yaml
@@ -325,7 +325,8 @@ groups:
         - name: reference
           neurodata_type_inc: VectorData
           dtype: text
-          doc: Description of the reference used for this electrode.
+          doc: Description of the reference electrode and/or reference scheme used for this electrode, e.g.,
+            "stainless steel skull screw" or "online common average referencing".
           quantity: '?'
     - name: intracellular_ephys
       doc: Metadata related to intracellular electrophysiology.

diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
@@ -9,6 +9,7 @@ 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. (#498)
 - Added ``cell_id`` field to ``IntracellularElectrode``. (#512)
 
 Major changes