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
commit2240072c36e34679ee6d91380ec4234a9c53df00 (patch)
tree604025df3bc0e50c35cc07c57dd21fda0203b845
parent5da1e11cf17de92798af696d9de756a8ee82922d (diff)
downloadpython-coveragepy-2240072c36e34679ee6d91380ec4234a9c53df00.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 92755f4..b3987ac 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