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 AnnotationSeries example to docs #1989

Merged
merged 2 commits into from
Nov 13, 2024
Merged

Conversation

stephprince
Copy link
Contributor

@stephprince stephprince commented Nov 12, 2024

Motivation

We are aiming for 100% coverage of all Neurodata types in our documentation. There is no example demonstrating the use of AnnotationSeries in the docs.

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

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.92%. Comparing base (9de4d4c) to head (b1c2b0d).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1989   +/-   ##
=======================================
  Coverage   91.92%   91.92%           
=======================================
  Files          27       27           
  Lines        2713     2713           
  Branches      708      708           
=======================================
  Hits         2494     2494           
  Misses        145      145           
  Partials       74       74           
Flag Coverage Δ
integration 72.87% <ø> (ø)
unit 82.89% <ø> (ø)

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 12, 2024 22:15
@stephprince
Copy link
Contributor Author

@bendichter I looked at some of the datasets using AnnotationSeries on DANDI and it seemed primarily associated with stimulus presentation, but let me know if you had a better example in mind.

@bendichter
Copy link
Contributor

Looks great!

image

@bendichter bendichter self-requested a review November 13, 2024 11:18
@bendichter bendichter merged commit 969c65f into dev Nov 13, 2024
24 of 25 checks passed
@bendichter bendichter deleted the add-annotation-series-example branch November 13, 2024 11:18
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.

2 participants