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 documentation for SpikeEventSeries #1983

Merged
merged 5 commits into from
Nov 8, 2024
Merged

Add documentation for SpikeEventSeries #1983

merged 5 commits into from
Nov 8, 2024

Conversation

stephprince
Copy link
Contributor

@stephprince stephprince commented Nov 7, 2024

Motivation

Fix #1937.

In addition to adding a documentation example for SpikeEventSeries, I updated the "Designating electrophysiology data" section to reflect my understanding of when SpikeEventSeries should be used and the upcoming deprecation to EventWaveform.

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?

cd docs
make clean && make html

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

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.87%. Comparing base (1bdffe8) to head (6930a94).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1983   +/-   ##
=======================================
  Coverage   91.87%   91.87%           
=======================================
  Files          27       27           
  Lines        2697     2697           
  Branches      704      704           
=======================================
  Hits         2478     2478           
  Misses        145      145           
  Partials       74       74           
Flag Coverage Δ
integration 72.71% <ø> (ø)
unit 83.27% <ø> (ø)

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.

@stephprince stephprince marked this pull request as ready for review November 8, 2024 18:44
@stephprince stephprince requested a review from rly November 8, 2024 18:44
@rly rly enabled auto-merge (squash) November 8, 2024 20:43
@rly rly merged commit 3c0dbfa into dev Nov 8, 2024
23 of 24 checks passed
@rly rly deleted the add-spikeeventseries-docs branch November 8, 2024 20:51
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.

[Documentation]: add documentation example for SpikeEventSeries
2 participants