summaryrefslogtreecommitdiff
path: root/doc/cmd.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2019-08-31 07:50:04 -0400
committerNed Batchelder <ned@nedbatchelder.com>2019-08-31 07:50:04 -0400
commit6e5418d9d7d03e0149ea5050f27ba28cdefc1104 (patch)
tree1d5f85f28b08415c1101fc2b176bd10e648b6b1a /doc/cmd.rst
parent9a78a80aaf8f8161b857ebf3cf02dd511181dd07 (diff)
downloadpython-coveragepy-git-6e5418d9d7d03e0149ea5050f27ba28cdefc1104.tar.gz
Tweaks to JSON report docs
Diffstat (limited to 'doc/cmd.rst')
-rw-r--r--doc/cmd.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index ad84a6ae..1aca89a8 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -477,14 +477,16 @@ You can specify the name of the output file with the ``-o`` switch.
Other common reporting options are described above in :ref:`cmd_reporting`.
+
.. _cmd_json:
JSON reporting
--------------
+--------------
The **json** command writes coverage data to a "coverage.json" file.
-You can specify the name of the output file with the ``-o`` switch.
+You can specify the name of the output file with the ``-o`` switch. The JSON
+can be nicely formatted by specifying the ``--pretty-print`` switch.
Other common reporting options are described above in :ref:`cmd_reporting`.