pytest-cov
pytest-cov copied to clipboard
Update README.rst
I propose adding clarification of the abbreviations in the coverage report. These are not mentioned anywhere in the documentation and there is even a StackOverflow question about those.
===== Addition to section "Usage" under the report ========
Where,
Stmtsrefers to the number of statements in your code.Missrefers to the number of statements that have not been run.Coveris test coverage, or(Stmts - Miss) / (Stmts) * 100.
===========================================
I can understand these are "obvious" for the experienced programmers, but maybe not for someone taking a code coverage tool into use for the first time.
I understand you want to keep the documentation short and to the point (it is).