esi-neuroscience / syncopy

Systems Neuroscience Computing in Python: user-friendly analysis of large-scale electrophysiology data
BSD 3-Clause "New" or "Revised" License
47 stars 14 forks source link

CHG: Improve signature and doc of synthdata routines #502

Closed tensionhead closed 1 year ago

tensionhead commented 1 year ago

Changes Summary

Reviewer Checklist

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.30 :warning:

Comparison is base (c16a5d2) 69.24% compared to head (ad755d6) 68.95%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #502 +/- ## ========================================== - Coverage 69.24% 68.95% -0.30% ========================================== Files 87 87 Lines 10158 10162 +4 Branches 2073 2073 ========================================== - Hits 7034 7007 -27 - Misses 2598 2617 +19 - Partials 526 538 +12 ``` | [Impacted Files](https://app.codecov.io/gh/esi-neuroscience/syncopy/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=esi-neuroscience) | Coverage Δ | | |---|---|---| | [syncopy/synthdata/analog.py](https://app.codecov.io/gh/esi-neuroscience/syncopy/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=esi-neuroscience#diff-c3luY29weS9zeW50aGRhdGEvYW5hbG9nLnB5) | `75.80% <100.00%> (+0.39%)` | :arrow_up: | | [syncopy/synthdata/utils.py](https://app.codecov.io/gh/esi-neuroscience/syncopy/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=esi-neuroscience#diff-c3luY29weS9zeW50aGRhdGEvdXRpbHMucHk=) | `100.00% <100.00%> (ø)` | | | [syncopy/tests/backend/test\_conn.py](https://app.codecov.io/gh/esi-neuroscience/syncopy/pull/502?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=esi-neuroscience#diff-c3luY29weS90ZXN0cy9iYWNrZW5kL3Rlc3RfY29ubi5weQ==) | `100.00% <100.00%> (ø)` | | ... and [8 files with indirect coverage changes](https://app.codecov.io/gh/esi-neuroscience/syncopy/pull/502/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=esi-neuroscience)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.