summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2022-11-05 12:51:13 -0400
committerNed Batchelder <ned@nedbatchelder.com>2022-11-05 13:02:22 -0400
commit01d86775522ed67a246f2b17657e7a119cb6b8a1 (patch)
treeddd6cfda0db8bdfb3d6ac88ecc06548b1c46eecc /doc
parent5a3e1e85c9e614b792cdaa5fad6f863e998295be (diff)
downloadpython-coveragepy-git-01d86775522ed67a246f2b17657e7a119cb6b8a1.tar.gz
docs: changelog and docs for `coverage report --format=markdown`
Diffstat (limited to 'doc')
-rw-r--r--doc/cmd.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index fd1f7d1a..7b49ec14 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -592,6 +592,10 @@ 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``
+creates plain text tables as shown above. ``--format=markdown`` creates
+Markdown tables.
+
Other common reporting options are described above in :ref:`cmd_reporting`.
These options can also be set in your .coveragerc file. See
:ref:`Configuration: [report] <config_report>`.