search

lina-usc / pylossless

🧠 EEG Processing pipeline that annotates continuous data
https://pylossless.readthedocs.io/en/latest/
MIT License
15 stars 8 forks source link

MAINT: Doc updates #112

Closed scott-huberty closed 1 year ago

scott-huberty commented 1 year ago

@christian-oreilly I did a lot of work to the API documentation. I will merge this before our meeting today so we avoid conflicts with subsequent PR's from our session (I edited a lot of the docstring).

I didn't touch any code except for moving FlaggedChs, FlaggedEpochs, FlaggedICs to their own module (was necessary for documentation building and we have been meaning to move these out of pipeline.py for a while now).

codecov[bot] commented 1 year ago

Codecov Report

Merging #112 (dcee275) into main (2ea12e4) will increase coverage by 1.25%. The diff coverage is 30.68%.

@@            Coverage Diff             @@
##             main     #112      +/-   ##
==========================================
+ Coverage   21.40%   22.65%   +1.25%     
==========================================
  Files           5        7       +2     
  Lines         556      565       +9     
==========================================
+ Hits          119      128       +9     
  Misses        437      437
Impacted Files Coverage Δ
pylossless/_utils.py 26.66% <26.66%> (ø)
pylossless/flagging.py 30.55% <30.55%> (ø)
pylossless/pipeline.py 18.58% <100.00%> (-0.55%) :arrow_down:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

christian-oreilly commented 1 year ago

I didn't touch any code except for moving FlaggedChs, FlaggedEpochs, FlaggedICs to their own module (was necessary for documentation building and we have been meaning to move these out of pipeline.py for a while now).

Indeed, this is overdue!

All good with me.