Skip to content

Commit a92016a

Browse files
ehennestadclaude
andauthored
Fix copy-paste doc errors in icephys, image, misc, and ophys schemas (#695)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent eed08cf commit a92016a

8 files changed

Lines changed: 29 additions & 13 deletions

File tree

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.10.0"
10+
value: "2.10.1-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.icephys.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ groups:
134134
- name: unit
135135
dtype: text
136136
value: farads
137-
doc: Unit of measurement for capacitance_fast, which is fixed to 'farads'.
137+
doc: Unit of measurement for capacitance_slow, which is fixed to 'farads'.
138138
- name: resistance_comp_bandwidth
139139
dtype: float32
140140
doc: Resistance compensation bandwidth, in hertz.

core/nwb.image.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,5 +233,5 @@ groups:
233233
- name: indexed_images
234234
target_type: Images
235235
doc: Link to Images object containing an ordered set of images that are indexed. The Images object
236-
must contain a 'ordered_images' dataset specifying the order of the images in the Images type.
236+
must contain a 'order_of_images' dataset specifying the order of the images in the Images type.
237237
quantity: '?'

core/nwb.misc.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ groups:
9797
- name: resolution
9898
dtype: float32
9999
value: -1.0
100-
doc: Smallest meaningful difference between values in data. Annotations have
101-
no units, so the value is fixed to -1.0.
100+
doc: Smallest meaningful difference between values in data. IntervalSeries
101+
stores integer markers, so the value is fixed to -1.0.
102102
- name: unit
103103
dtype: text
104104
value: n/a
105-
doc: Base unit of measurement for working with the data. Annotations have
106-
no units, so the value is fixed to 'n/a'.
105+
doc: Base unit of measurement for working with the data. IntervalSeries
106+
stores integer markers with no physical unit, so the value is fixed to 'n/a'.
107107

108108
- neurodata_type_def: FrequencyBandsTable
109109
neurodata_type_inc: DynamicTable

core/nwb.namespace.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,4 @@ namespaces:
6060
- doc: This source module contains neurodata_type for retinotopy data.
6161
source: nwb.retinotopy.yaml
6262
title: Retinotopy
63-
version: "2.10.0"
63+
version: "2.10.1-alpha"

core/nwb.ophys.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ groups:
190190
doc: Signals from ROIs.
191191
- name: rois
192192
neurodata_type_inc: DynamicTableRegion
193-
doc: DynamicTableRegion referencing into an ROITable containing information on the ROIs
194-
stored in this timeseries.
193+
doc: DynamicTableRegion referencing into a PlaneSegmentation table containing information on the ROIs
194+
stored in this TimeSeries.
195195

196196
- neurodata_type_def: DfOverF
197197
neurodata_type_inc: NWBDataInterface
@@ -431,7 +431,7 @@ groups:
431431
links:
432432
- name: device
433433
target_type: Device
434-
doc: Link to the Device object that was used to record from this electrode.
434+
doc: Link to the Device object (e.g., microscope) used to acquire images from this imaging plane.
435435

436436
- neurodata_type_def: OpticalChannel
437437
neurodata_type_inc: NWBContainer

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.10.0'
86+
version = '2.10.1'
8787
# The full version, including alpha/beta/rc tags.
88-
release = '2.10.0'
88+
release = '2.10.1-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: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33
Release Notes
44
=============
55

6+
2.10.1 (Upcoming)
7+
-----------------
8+
9+
Bug fixes
10+
^^^^^^^^^
11+
- Fixed copy-paste error in ``VoltageClampSeries.capacitance_slow`` unit attribute doc, which incorrectly
12+
referenced ``capacitance_fast``.
13+
- Fixed ``IntervalSeries.data`` resolution and unit attribute docs, which were verbatim copy-paste from
14+
``AnnotationSeries`` and incorrectly described the field as storing annotations.
15+
- Fixed ``IndexSeries.indexed_images`` link doc, which referenced the non-existent dataset name
16+
``'ordered_images'``; corrected to ``'order_of_images'`` to match the actual field in ``Images``.
17+
- Fixed ``ImagingPlane.device`` link doc, which incorrectly described the device as being used to
18+
"record from this electrode"; updated to reflect optical physiology imaging context.
19+
- Fixed ``RoiResponseSeries.rois`` doc, which referenced the non-existent type ``ROITable``; corrected
20+
to ``PlaneSegmentation`` to match the actual type used for ROI segmentation results.
21+
622
2.10.0 (June 18, 2026)
723
----------------------
824

0 commit comments

Comments
 (0)