Improve docval for IndexSeries init #2104
Draft
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.
Motivation
In coordination with NeurodataWithoutBorders/nwb-schema#644
The goal is to not write
resolution
,conversion
, andoffset
forIndexSeries
.This PR also updates
IndexSeries.__init__
so thatunit
cannot be passed in, since the schema requires a fixed value of "N/A" and currently in PyNWB, passing any different value will result in an error. This change improves the usability -- users do not need to provide `unit="N/A" during construction.WIP. Removing
resolution
,conversion
, andoffset
forIndexSeries.__init__
does not work because whenresolution=None
is passed toTimeSeries.__init__
, then resolution is set to the default value for resolution (-1) specified inTimeSeries
.How to test the behavior?
Checklist
ruff check . && codespell
from the source directory.