Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make ImagingPlane.description optional #2051

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Make ImagingPlane.description optional #2051

wants to merge 3 commits into from

Conversation

rly
Copy link
Contributor

@rly rly commented Mar 4, 2025

Motivation

Fix #2049

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff check . && codespell from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • 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.

Copy link

codecov bot commented Mar 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.84%. Comparing base (01d9ab9) to head (ed8965a).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #2051   +/-   ##
=======================================
  Coverage   92.84%   92.84%           
=======================================
  Files          28       28           
  Lines        2755     2755           
  Branches      716      716           
=======================================
  Hits         2558     2558           
  Misses        127      127           
  Partials       70       70           
Flag Coverage Δ
integration 73.72% <ø> (ø)
unit 82.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rly rly marked this pull request as ready for review March 4, 2025 18:14
@rly rly requested a review from stephprince March 4, 2025 18:14
## [Upcoming]

### Bug fixes
- Made `ImagingPlane.description` optional to conform with the NWB Schema. Note that if you use positional arguments to create
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a breaking change since the order of positional arguments was changed, correct?

Would it be better to take the approach that was used in add_electrode to prevent breaking changes until positional arguments are deprecated in the next major release?

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.

Description of ImagingPlane is required by PyNWB, but not schema
2 participants