summaryrefslogtreecommitdiff
path: root/doc/cmd.rst
diff options
context:
space:
mode:
authorstepeos <82703776+stepeos@users.noreply.github.com>2022-11-05 17:29:04 +0100
committerGitHub <noreply@github.com>2022-11-05 09:29:04 -0700
commitcf1efa814e905ab1e2bc17795b1dbe6d437b39e5 (patch)
treee7f236575db700b37b595669bd8dbe803b1b53d4 /doc/cmd.rst
parent27fd4a9b8999dba408d1bc5a5df675d7caaa85b8 (diff)
downloadpython-coveragepy-git-cf1efa814e905ab1e2bc17795b1dbe6d437b39e5.tar.gz
feat: report terminal output in Markdown Table format #1418 (#1479)
* refactoring normal reporting text output * implemented markdown feature from #1418 * minor changes * fixed text output * fixed precision for text and markdown report format * minor changes * finished testing for markdown format feature * fixed testing outside test_summary.py * removed fixed-length widespace padding for tests * removed whitespaces * refactoring, fixing docs, rewriting cmd args * fixing code quality * implementing requested changes * doc fix * test: add another test of correct report formatting * fixed precision printing test * style: adjust the formatting Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Diffstat (limited to 'doc/cmd.rst')
-rw-r--r--doc/cmd.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index f8de0cb3..fd1f7d1a 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -518,6 +518,7 @@ 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
-i, --ignore-errors Ignore errors while reading source files.
--include=PAT1,PAT2,...
Include only files whose paths match one of these
@@ -540,7 +541,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: 2f8dde61bab2f44fbfe837aeae87dfd2)
+.. [[[end]]] (checksum: 8c671de502a388159689082d906f786a)
The ``-m`` flag also shows the line numbers of missing statements::