Open
Conversation
Add clarification for abbreviations for "newbie" users
Collaborator
|
Another option: add information like this to the coverage.py docs, with a clear indication from here that much of the pytest-cov behavior is from coverage.py. |
|
additionally, I have reports with As well some explanation on the coverage would be useful. I have notation like these in the
|
Member
That's probably a loop with a
That's some control flow interrupt, I think. Perhaps some sort of |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).