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

[Documentation]: add documentation example for SpikeEventSeries #1937

Closed
3 tasks done
stephprince opened this issue Jul 23, 2024 · 0 comments · Fixed by #1983
Closed
3 tasks done

[Documentation]: add documentation example for SpikeEventSeries #1937

stephprince opened this issue Jul 23, 2024 · 0 comments · Fixed by #1983
Assignees
Labels
category: proposal proposed enhancements or new features priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation
Milestone

Comments

@stephprince
Copy link
Contributor

What would you like changed or added to the documentation and why?

As discussed in the NWB meeting today, SpikeEventSeries is not well documented.

SpikeEventSeries is meant to store snapshots/snippets of recorded spike events, e.g., threshold crossings of high-pass filtered voltage data in extracellular electrophysiology, which may be detected by ephys hardware or computed during spike sorting. This data type is briefly mentioned in the ecephys tutorial as a way to store waveform snippets.

I propose we add a short example to the Extracellular Electrophysiology Data tutorial demonstrating how to use this data type, since this tutorial covers other ways of designating and storing different types of electrophysiological data.

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

@stephprince stephprince self-assigned this Jul 23, 2024
@stephprince stephprince added category: enhancement improvements of code or code behavior priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation category: proposal proposed enhancements or new features and removed category: enhancement improvements of code or code behavior labels Jul 23, 2024
@stephprince stephprince added this to the 2.9.0 milestone Jul 23, 2024
@rly rly modified the milestones: 2.9.0, Next Major Release - 3.0 Sep 5, 2024
@rly rly closed this as completed in #1983 Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: proposal proposed enhancements or new features priority: medium non-critical problem and/or affecting only a small set of NWB users topic: docs issues related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants