-
Notifications
You must be signed in to change notification settings - Fork 85
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
Enh/device description #723
Conversation
Looks like some of tests need to be updated, but other than that it looks good to me. |
I prefer these types of additions to be optional. This change will require changes to dozen different conversion scripts and does not offer me much utility. I don't think these types of descriptive fields need to be required |
Then we should just remove Device. A group with a name and a constant help string doesn’t do much. |
Codecov Report
@@ Coverage Diff @@
## dev #723 +/- ##
=========================================
+ Coverage 72.29% 74.49% +2.2%
=========================================
Files 36 60 +24
Lines 2718 6905 +4187
Branches 513 1444 +931
=========================================
+ Hits 1965 5144 +3179
- Misses 632 1355 +723
- Partials 121 406 +285
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
making Device optional obviates the Device io file
The addition of |
@@ -235,6 +235,10 @@ groups: | |||
dtype: text | |||
doc: Value is 'A recording device e.g. amplifier'. | |||
value: A recording device e.g. amplifier | |||
datasets: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this a dataset and not an attribute? I would not expect this to be changed once it is written, so shouldn't it be an attribute (NeurodataWithoutBorders/nwb-schema#48)? Making this required would be a schema-breaking change, so I would like to make this optional.
Motivation
After #695, Device became a group with a help string. This PR adds a required description field. A Device ObjectMapper was also included for setting a default value for those files generated prior to this change.
This change was inspired by discussions with @ageorgou
Checklist
flake8
from the source directory.#XXX
notation whereXXX
is the issue number ?