cta-observatory / pyirf

Python IRF builder
https://pyirf.readthedocs.io/en/stable/
MIT License
15 stars 25 forks source link

Some clarification of what functions do #266

Closed Tobychev closed 10 months ago

Tobychev commented 11 months ago

After struggling to understand what these functions do, I reworked the doc strings to be a bit more clear, added missing return value annotations.

codecov[bot] commented 11 months ago

Codecov Report

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

Comparison is base (4b617cc) 95.34% compared to head (fdd61c2) 95.35%. Report is 4 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #266 +/- ## ======================================= Coverage 95.34% 95.35% ======================================= Files 60 60 Lines 3096 3097 +1 ======================================= + Hits 2952 2953 +1 Misses 144 144 ``` | [Files](https://app.codecov.io/gh/cta-observatory/pyirf/pull/266?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory) | Coverage Δ | | |---|---|---| | [pyirf/binning.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/266?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvYmlubmluZy5weQ==) | `96.66% <ø> (ø)` | | | [pyirf/cuts.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/266?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvY3V0cy5weQ==) | `95.83% <ø> (ø)` | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/cta-observatory/pyirf/pull/266/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory)

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