diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2022-11-06 12:17:11 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2022-11-06 13:33:53 -0500 |
| commit | e5a15c1d5652574ba85673f814b09f5da333fca8 (patch) | |
| tree | 889dc8497bfb1817f91d8322f74ba35db5efceb2 /doc/cmd.rst | |
| parent | 30f1ecf0657fa89b56eab300f10c58852edbbcdd (diff) | |
| download | python-coveragepy-git-e5a15c1d5652574ba85673f814b09f5da333fca8.tar.gz | |
feat: --format=total writes just the total number
Diffstat (limited to 'doc/cmd.rst')
| -rw-r--r-- | doc/cmd.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index 7b49ec14..be323c0c 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -518,7 +518,8 @@ as a percentage. file. Defaults to '.coverage'. [env: COVERAGE_FILE] --fail-under=MIN Exit with a status of 2 if the total coverage is less than MIN. - --format=FORMAT Output format, either text (default) or markdown + --format=FORMAT Output format, either text (default), markdown, or + total. -i, --ignore-errors Ignore errors while reading source files. --include=PAT1,PAT2,... Include only files whose paths match one of these @@ -541,7 +542,7 @@ as a percentage. --rcfile=RCFILE Specify configuration file. By default '.coveragerc', 'setup.cfg', 'tox.ini', and 'pyproject.toml' are tried. [env: COVERAGE_RCFILE] -.. [[[end]]] (checksum: 8c671de502a388159689082d906f786a) +.. [[[end]]] (checksum: 167272a29d9e7eb017a592a0e0747a06) The ``-m`` flag also shows the line numbers of missing statements:: @@ -592,9 +593,11 @@ decimal point in coverage percentages, defaulting to none. The ``--sort`` option is the name of a column to sort the report by. -The ``--format`` option controls the style of the table. ``--format=text`` +The ``--format`` option controls the style of the report. ``--format=text`` creates plain text tables as shown above. ``--format=markdown`` creates -Markdown tables. +Markdown tables. ``--format=total`` writes out a single number, the total +coverage percentage as shown at the end of the tables, but without a percent +sign. Other common reporting options are described above in :ref:`cmd_reporting`. These options can also be set in your .coveragerc file. See |