search

catalystneuro / neuroconv

Create NWB files by converting and combining neural data in proprietary formats and adding essential metadata.
https://neuroconv.readthedocs.io
BSD 3-Clause "New" or "Revised" License
51 stars 23 forks source link

Using ruff rule to enforce the existence of docstrings in public functions #1062

Closed h-mayorquin closed 2 months ago

h-mayorquin commented 2 months ago

As in the title.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.31%. Comparing base (81a022d) to head (b82a08c). Report is 3 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062/graphs/tree.svg?width=650&height=150&src=pr&token=h63OQoWehP&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro)](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro) ```diff @@ Coverage Diff @@ ## main #1062 +/- ## ========================================== - Coverage 90.32% 90.31% -0.01% ========================================== Files 129 129 Lines 7996 7989 -7 ========================================== - Hits 7222 7215 -7 Misses 774 774 ``` | [Flag](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro) | `90.31% <100.00%> (-0.01%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files with missing lines](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro) | Coverage Δ | | |---|---|---| | [...rfaces/ecephys/blackrock/blackrockdatainterface.py](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?src=pr&el=tree&filepath=src%2Fneuroconv%2Fdatainterfaces%2Fecephys%2Fblackrock%2Fblackrockdatainterface.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro#diff-c3JjL25ldXJvY29udi9kYXRhaW50ZXJmYWNlcy9lY2VwaHlzL2JsYWNrcm9jay9ibGFja3JvY2tkYXRhaW50ZXJmYWNlLnB5) | `94.54% <100.00%> (ø)` | | | [...v/datainterfaces/ecephys/blackrock/header\_tools.py](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?src=pr&el=tree&filepath=src%2Fneuroconv%2Fdatainterfaces%2Fecephys%2Fblackrock%2Fheader_tools.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro#diff-c3JjL25ldXJvY29udi9kYXRhaW50ZXJmYWNlcy9lY2VwaHlzL2JsYWNrcm9jay9oZWFkZXJfdG9vbHMucHk=) | `100.00% <100.00%> (ø)` | | | [src/neuroconv/tools/roiextractors/roiextractors.py](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?src=pr&el=tree&filepath=src%2Fneuroconv%2Ftools%2Froiextractors%2Froiextractors.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro#diff-c3JjL25ldXJvY29udi90b29scy9yb2lleHRyYWN0b3JzL3JvaWV4dHJhY3RvcnMucHk=) | `82.22% <100.00%> (+0.03%)` | :arrow_up: | | [...c/neuroconv/tools/spikeinterface/spikeinterface.py](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?src=pr&el=tree&filepath=src%2Fneuroconv%2Ftools%2Fspikeinterface%2Fspikeinterface.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro#diff-c3JjL25ldXJvY29udi90b29scy9zcGlrZWludGVyZmFjZS9zcGlrZWludGVyZmFjZS5weQ==) | `90.77% <100.00%> (-0.93%)` | :arrow_down: | | [src/neuroconv/tools/testing/mock\_probes.py](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?src=pr&el=tree&filepath=src%2Fneuroconv%2Ftools%2Ftesting%2Fmock_probes.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro#diff-c3JjL25ldXJvY29udi90b29scy90ZXN0aW5nL21vY2tfcHJvYmVzLnB5) | `0.00% <ø> (ø)` | | | [src/neuroconv/utils/json\_schema.py](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062?src=pr&el=tree&filepath=src%2Fneuroconv%2Futils%2Fjson_schema.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro#diff-c3JjL25ldXJvY29udi91dGlscy9qc29uX3NjaGVtYS5weQ==) | `96.87% <100.00%> (ø)` | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/catalystneuro/neuroconv/pull/1062/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=catalystneuro)