pytest-cov
pytest-cov copied to clipboard
pytest-dev
--cov-branch does not seem to be mentioned in the documentation
At least I could not find it here: http://pytest-cov.readthedocs.io/en/latest/reporting.html
I found it accidentally. It would be nice if it was included in the docs.
Agreed, the only mention of --cov-branch is in the changelog.
Also, it does not seem to be documented anywhere weather or not the appending --cov-branch will only test branch coverage or will test branch coverage additionally to normal line coverage.
Looks like it's on the configuration page: https://pytest-cov.readthedocs.io/en/latest/config.html#reference
I agree that it would be nice to have a small section about it on the reporting page. Something like:
The --cov-branch flag enables branch coverage, where every possible branch path through the code is included. The generated report will then show which branch paths were not executed along with the lines that were not covered.
