Fix copy-paste doc errors in icephys, image, misc, and ophys schemas#695
Open
ehennestad wants to merge 4 commits into
Open
Fix copy-paste doc errors in icephys, image, misc, and ophys schemas#695ehennestad wants to merge 4 commits into
ehennestad wants to merge 4 commits into
Conversation
- nwb.icephys.yaml: VoltageClampSeries.capacitance_slow unit attribute doc
incorrectly referenced 'capacitance_fast'; corrected to 'capacitance_slow'
- nwb.misc.yaml: IntervalSeries.data resolution and unit attribute docs were
verbatim copy-paste from AnnotationSeries ("Annotations have no units…");
updated to accurately describe IntervalSeries integer marker semantics
- nwb.image.yaml: IndexSeries.indexed_images link doc referenced the
non-existent dataset name 'ordered_images'; corrected to 'order_of_images'
to match the actual field defined in nwb.base.yaml
- nwb.ophys.yaml: ImagingPlane.device link doc said "record from this
electrode", which is domain-incorrect for an optical physiology type;
updated to reference imaging/microscope usage
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- RoiResponseSeries.rois: replace non-existent type 'ROITable' with 'PlaneSegmentation'; fix 'timeseries' capitalisation to 'TimeSeries' - ImagingPlane.device: add missing comma after 'e.g.' Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
oruebel
approved these changes
Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of changes
nwb.icephys.yaml:VoltageClampSeries.capacitance_slowunit attribute doc incorrectly referencedcapacitance_fast; corrected tocapacitance_slow.nwb.misc.yaml:IntervalSeries.dataresolution and unit attribute docs were verbatim copy-paste fromAnnotationSeries("Annotations have no units…"); updated to accurately describeIntervalSeriesinteger marker semantics.nwb.image.yaml:IndexSeries.indexed_imageslink doc referenced the non-existent dataset name'ordered_images'; corrected to'order_of_images'to match the actual field defined innwb.base.yaml.nwb.ophys.yaml:ImagingPlane.devicelink doc said "record from this electrode", which is domain-incorrect for an optical physiology type; updated to reference imaging/microscope context.2.10.1-alphaand release notes updated.All changes are documentation-only (
doc:strings and release notes).Checklist
For all schema changes:
docs/format/source/format_release_notes.rst.hdmf-common-schemapoints to the latest release and not the latest commit on themainbranch.If this is the first schema change after a schema release (i.e., the version string in
core/nwb.namespace.yamldoes notend in "-alpha"), then:
core/nwb.namespace.yamlandcore/nwb.file.yamlto the next major/minor/patch version with the suffix "-alpha". (bumped to2.10.1-alpha)versionvariable indocs/format/source/conf.pyto the next version without the suffix "-alpha" (2.10.1).releasevariable indocs/format/source/conf.pyto the next version with the suffix "-alpha" (2.10.1-alpha).docs/format/source/format_release_notes.rstfor the new version with the date "Upcoming" in parentheses.