Skip to content

docs: explain branch coverage reporting #769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ketpatil77 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: explain branch coverage reporting #769

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/reporting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ Reporting

It is possible to generate any combination of the reports for a single test run.

To measure branch coverage in addition to line coverage, pass ``--cov-branch``::

pytest --cov=myproj --cov-branch tests/

This reports whether each conditional branch was exercised. The option can also be
enabled in the coverage configuration; see :doc:`config` for details.

The available reports are terminal (with or without missing line numbers shown), HTML, XML, JSON, Markdown (either in 'write' or 'append'
mode to file), LCOV and annotated source code.

Expand Down