Skip to content

Fix copy-paste doc errors in icephys, image, misc, and ophys schemas#695

Open
ehennestad wants to merge 4 commits into
devfrom
fix/doc-copy-paste-errors
Open

Fix copy-paste doc errors in icephys, image, misc, and ophys schemas#695
ehennestad wants to merge 4 commits into
devfrom
fix/doc-copy-paste-errors

Conversation

@ehennestad

@ehennestad ehennestad commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Summary of changes

  • 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 context.
  • Version bumped to 2.10.1-alpha and release notes updated.

All changes are documentation-only (doc: strings and release notes).

Checklist

For all schema changes:

  • Add release notes for the PR to docs/format/source/format_release_notes.rst.
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.
  • Make sure that hdmf-common-schema points to the latest release and not the latest commit on the main branch.

If this is the first schema change after a schema release (i.e., the version string in core/nwb.namespace.yaml does not
end in "-alpha"), then:

  • Update the version string in core/nwb.namespace.yaml and core/nwb.file.yaml to the next major/minor/patch version with the suffix "-alpha". (bumped to 2.10.1-alpha)
  • Update the value of the version variable in docs/format/source/conf.py to the next version without the suffix "-alpha" (2.10.1).
  • Update the value of the release variable in docs/format/source/conf.py to the next version with the suffix "-alpha" (2.10.1-alpha).
  • Add a new section in the release notes docs/format/source/format_release_notes.rst for the new version with the date "Upcoming" in parentheses.

ehennestad and others added 2 commits June 28, 2026 07:57
- 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>
ehennestad and others added 2 commits June 28, 2026 14:43
- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants