Add documentation for SpikeEventSeries #1983
Merged
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
Fix #1937.
In addition to adding a documentation example for
SpikeEventSeries
, I updated the "Designating electrophysiology data" section to reflect my understanding of whenSpikeEventSeries
should be used and the upcoming deprecation toEventWaveform
.I discussed with @oruebel that since there are now optional, predefined columns in the
Units
table for storing sorted spike waveforms, then I believe SpikeEventSeries should predominantly be used for storing unsorted spiking activity?How to test the behavior?
Checklist
ruff check . && codespell
from the source directory.