search

gwpy / gwsumm

Gravitational-wave interferometer summary information system
GNU General Public License v3.0
12 stars 23 forks source link

Add better commenting and docstrings to gwsumm/archive.py #404

Closed eagoetz closed 5 months ago

eagoetz commented 5 months ago

This PR adds better docstrings and code comments to archive.py

codecov[bot] commented 5 months ago

Codecov Report

Attention: Patch coverage is 0% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 49.64%. Comparing base (720bd0c) to head (bc10d5f). Report is 3 commits behind head on master.

Files Patch % Lines
gwsumm/archive.py 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #404 +/- ## ======================================= Coverage 49.64% 49.64% ======================================= Files 60 60 Lines 8823 8823 ======================================= Hits 4380 4380 Misses 4443 4443 ``` | [Flag](https://app.codecov.io/gh/gwpy/gwsumm/pull/404/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gwpy) | Coverage Δ | | |---|---|---| | [Linux](https://app.codecov.io/gh/gwpy/gwsumm/pull/404/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gwpy) | `49.64% <0.00%> (ø)` | | | [macOS](https://app.codecov.io/gh/gwpy/gwsumm/pull/404/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gwpy) | `49.64% <0.00%> (?)` | | | [python3.10](https://app.codecov.io/gh/gwpy/gwsumm/pull/404/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gwpy) | `49.64% <0.00%> (ø)` | | | [python3.11](https://app.codecov.io/gh/gwpy/gwsumm/pull/404/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gwpy) | `49.64% <0.00%> (ø)` | | | [python3.9](https://app.codecov.io/gh/gwpy/gwsumm/pull/404/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gwpy) | `49.64% <0.00%> (ø)` | | 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=gwpy#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.