Clarify electrode impedance and filtering docs (#457)

NeurodataWithoutBorders · Aug 24, 2020 · 35a1d8d · 35a1d8d
1 parent 1ae0155
commit 35a1d8d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/core/nwb.file.yaml b/core/nwb.file.yaml
@@ -286,7 +286,7 @@ groups:
         - name: imp
           neurodata_type_inc: VectorData
           dtype: float32
-          doc: Impedance of the channel.
+          doc: Impedance of the channel, in ohms.
         - name: location
           neurodata_type_inc: VectorData
           dtype: text
@@ -296,7 +296,7 @@ groups:
         - name: filtering
           neurodata_type_inc: VectorData
           dtype: float32
-          doc: Description of hardware filtering.
+          doc: Description of hardware filtering, including the filter name and frequency cutoffs.
         - name: group
           neurodata_type_inc: VectorData
           dtype:

diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
@@ -7,6 +7,7 @@ Release Notes
 - Add optional ``strain`` field to ``Subject``.
 - Add to ``DecompositionSeries`` an optional ``DynamicTableRegion`` called ``source_channels``.
 - Add to ``ImageSeries`` an optional link to ``Device``.
+- Clarify documentation for electrode impedance and filtering.
 - Add optional "continuity" field to `TimeSeries`.
 - Update hdmf-common-schema to version 1.2.0. Release notes:
   - Add software process documentation.