glass-dev / glass / 11177395425

94%

push

github

gh-282: extend `coverage` options to improve output (#318)

Closes #282. Run locally, the output looks like below. Makes it easy to
know what needs prioritising to improve the overall score. Options come
from my experience with
https://github.com/astro-informatics/sleplet/blob/9d8884177/pyproject.toml#L102-L110.

```
---------- coverage: platform darwin, python 3.12.6-final-0 ----------
Name                      Stmts   Miss Branch BrPart  Cover
-----------------------------------------------------------
glass/ext/__init__.py         6      6      2      0     0%
glass/fields.py             173    146     82      1    12%
glass/observations.py        59     47     12      0    17%
glass/shells.py             144     57     40      2    54%
glass/lensing.py            132     55     36      2    55%
glass/galaxies.py            59     18     22      4    68%
glass/user.py                34      9     14      3    71%
glass/points.py              88     14     40     12    78%
glass/core/algorithm.py      42      3     16      3    90%
glass/shapes.py              75      0     22      3    97%
-----------------------------------------------------------
TOTAL                       856    355    302     30    54%

3 files skipped due to complete coverage.
```

Coverage is expected to decrease as we are now using branch coverage.
See explanation here:
https://coverage.readthedocs.io/en/latest/branch.html.

88 of 163 branches covered (53.99%)

Branch coverage included in aggregate %.

501 of 856 relevant lines covered (58.53%)

3.51 hits per line