summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2017-12-19 12:37:59 -0500
committerNed Batchelder <ned@nedbatchelder.com>2017-12-19 12:37:59 -0500
commit5699789de2fd5b647e4b98341c83d1667d3e9bdb (patch)
tree6f42a53cbcacad7aa1907c618845c695f81886e9
parent02f8c2272ca3e24e70a942e5c50f73118fda2a3d (diff)
downloadpython-coveragepy-git-5699789de2fd5b647e4b98341c83d1667d3e9bdb.tar.gz
Add a little clarification to the quick start
-rw-r--r--doc/index.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 92755f4b..b3987ac6 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -105,6 +105,12 @@ Getting started is easy:
.. code-block:: console
+ # if you usually do:
+ #
+ # $ python my_program.py arg1 arg2
+ #
+ # then instead do:
+
$ coverage run my_program.py arg1 arg2
blah blah ..your program's output.. blah blah