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

Add model_number, model_name, and serial_number to Device #1997

Merged
merged 3 commits into from
Nov 19, 2024

Conversation

rly
Copy link
Contributor

@rly rly commented Nov 19, 2024

Motivation

See NeurodataWithoutBorders/nwb-schema#594

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 Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (nwb_schema_2.8.0@1b46014). Learn more about missing BASE report.

Additional details and impacted files
@@                 Coverage Diff                 @@
##             nwb_schema_2.8.0    #1997   +/-   ##
===================================================
  Coverage                    ?   91.93%           
===================================================
  Files                       ?       27           
  Lines                       ?     2715           
  Branches                    ?      708           
===================================================
  Hits                        ?     2496           
  Misses                      ?      145           
  Partials                    ?       74           
Flag Coverage Δ
integration 72.89% <100.00%> (?)
unit 82.90% <100.00%> (?)

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.


🚨 Try these New Features:

@rly rly requested a review from stephprince November 19, 2024 00:38
Copy link
Contributor

@stephprince stephprince left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for updating the tutorial examples as well.

If we wanted to be consistent throughout, we could also update the ogen and icephys docs:

device = nwbfile.create_device(
name="device",
description="description of device",
manufacturer="optional but recommended",
)

device = nwbfile.create_device(name="Heka ITC-1600")

but I don't know if that's really necessary.

@rly
Copy link
Contributor Author

rly commented Nov 19, 2024

Looks great! Thanks for updating the tutorial examples as well.

If we wanted to be consistent throughout, we could also update the ogen and icephys docs:

device = nwbfile.create_device(
name="device",
description="description of device",
manufacturer="optional but recommended",
)

device = nwbfile.create_device(name="Heka ITC-1600")

but I don't know if that's really necessary.

I thought that too but I was not sure what the best example values for those are... do you have any suggestions? We could also punt this to an issue for a later fix.

@stephprince
Copy link
Contributor

I thought that too but I was not sure what the best example values for those are... do you have any suggestions? We could also punt this to an issue for a later fix.

I'm also not sure what the best examples would be... I'm good punting to a separate issue and getting feedback from someone who currently uses those techniques.

@rly rly merged commit 52a7e6d into nwb_schema_2.8.0 Nov 19, 2024
23 of 24 checks passed
@rly rly deleted the device_model_number branch November 19, 2024 01:29
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