search

bycycle-tools / bycycle

Cycle-by-cycle analysis of neural oscillations.
https://bycycle-tools.github.io/
Apache License 2.0
82 stars 21 forks source link

[ENH] Docstring examples #69

Closed ryanhammonds closed 4 years ago

ryanhammonds commented 4 years ago

The first commit is the open PRs squash into one, which can be dropped as the open PRs are merged in. The second commit has the added examples.

TomDonoghue commented 4 years ago

Some as the doc PR - I had a quick check, and made some small comments. Once everything is merged in, this looks good to me to merge in, to up the doc-example coverage.

codecov-commenter commented 4 years ago

Codecov Report

Merging #69 into master will decrease coverage by 0.10%. The diff coverage is 96.36%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #69      +/-   ##
==========================================
- Coverage   96.18%   96.08%   -0.11%     
==========================================
  Files          19       21       +2     
  Lines         551      638      +87     
==========================================
+ Hits          530      613      +83     
- Misses         21       25       +4
Impacted Files Coverage Δ
bycycle/burst/amp.py 100.00% <ø> (ø)
bycycle/burst/cycle.py 100.00% <ø> (ø)
bycycle/burst/utils.py 100.00% <ø> (ø)
bycycle/cyclepoints/phase.py 100.00% <ø> (ø)
bycycle/features/cyclepoints.py 100.00% <ø> (ø)
bycycle/features/features.py 96.15% <ø> (ø)
bycycle/plts/cyclepoints.py 100.00% <ø> (ø)
bycycle/plts/features.py 93.61% <ø> (ø)
bycycle/utils/dataframes.py 100.00% <ø> (ø)
bycycle/utils/timeseries.py 100.00% <ø> (ø)
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update ab69c6b...d46a3e7. Read the comment docs.

ryanhammonds commented 4 years ago

I addressed all of your comments in the latest commit, added a few missing docstring examples, and updated to ensure make doctests all passed.

I also rebased / force pushed to drop the first commit: unmerged prs that are now merged.