Skip to content

Commit a79b7ec

Browse files
h-mayorquinrly
andauthored
improve electrode group documentation (#659)
Co-authored-by: Ryan Ly <[email protected]>
1 parent ade50ef commit a79b7ec

File tree

5 files changed

+18
-5
lines changed

5 files changed

+18
-5
lines changed

core/nwb.ecephys.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,10 @@ groups:
235235

236236
- neurodata_type_def: ElectrodeGroup
237237
neurodata_type_inc: NWBContainer
238-
doc: A physical grouping of electrodes, e.g. a shank of an array.
238+
doc: A physical grouping of electrodes, e.g., a shank of an array. An electrode group is typically used to describe
239+
electrodes that are physically connected on a single device and are often (but not always) used together for
240+
analysis, such as for spike sorting. Note that this is descriptive metadata; electrodes from different groups
241+
can still be spike-sorted together if needed.
239242
attributes:
240243
- name: description
241244
dtype: text

core/nwb.file.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ groups:
77
attributes:
88
- name: nwb_version
99
dtype: text
10-
value: "2.9.0"
10+
value: "2.10.0-alpha"
1111
doc: File version string. Use semantic versioning, e.g. 1.2.1. This will be the
1212
name of the format with trailing major, minor and patch numbers.
1313
datasets:

core/nwb.namespace.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ namespaces:
5757
- doc: This source module contains neurodata_type for retinotopy data.
5858
source: nwb.retinotopy.yaml
5959
title: Retinotopy
60-
version: "2.9.0"
60+
version: "2.10.0-alpha"

docs/format/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ def setup(app):
8383
# built documents.
8484
#
8585
# The short X.Y version.
86-
version = '2.9.0'
86+
version = '2.10.0'
8787
# The full version, including alpha/beta/rc tags.
88-
release = '2.9.0'
88+
release = '2.10.0-alpha'
8989

9090
# The language for content autogenerated by Sphinx. Refer to documentation
9191
# for a list of supported languages.

docs/format/source/format_release_notes.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@
33
Release Notes
44
=============
55

6+
Upcoming
7+
--------
8+
9+
Minor changes
10+
^^^^^^^^^^^^^
11+
- Improved documentation of ``ElectrodeGroup`` to clarify its purpose as a physical grouping of electrodes
12+
that are typically used together for analysis, such as spike sorting. (#659)
13+
14+
615
2.9.0 (June 26, 2025)
716
---------------------
817

@@ -33,6 +42,7 @@ Minor changes
3342
- Clarified documentation of ``PlaneSegmentation`` that at least one of ``image_mask``, ``pixel_mask``,
3443
and ``voxel_mask`` is required. (#636)
3544

45+
3646
2.8.0 (November 24, 2024)
3747
-------------------------
3848

0 commit comments

Comments
 (0)