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

Improve docs around waveforms #1936

Draft
wants to merge 3 commits into
base: dev
Choose a base branch
from
Draft

Improve docs around waveforms #1936

wants to merge 3 commits into from

Conversation

rly
Copy link
Contributor

@rly rly commented Jul 19, 2024

Motivation

It is confusing to write Units waveforms with different numbers of electrodes and units. This PR improves the API docs for Units.add_unit.

image

How to test the behavior?

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.

@rly
Copy link
Contributor Author

rly commented Jul 19, 2024

cc @khl02007

@rly rly requested a review from stephprince July 19, 2024 17:17
Copy link

codecov bot commented Jul 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.20%. Comparing base (fcd7008) to head (da0e55a).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1936   +/-   ##
=======================================
  Coverage   92.20%   92.20%           
=======================================
  Files          27       27           
  Lines        2656     2656           
  Branches      693      693           
=======================================
  Hits         2449     2449           
  Misses        134      134           
  Partials       73       73           
Flag Coverage Δ
integration 73.15% <100.00%> (ø)
unit 83.77% <100.00%> (ø)

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.

@rly rly marked this pull request as draft July 19, 2024 18:59
@rly rly removed the request for review from stephprince July 19, 2024 19:27
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.

1 participant