diff options
| -rw-r--r-- | doc/cmd.rst | 9 | ||||
| -rw-r--r-- | doc/index.rst | 16 |
2 files changed, 17 insertions, 8 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index bb01fd51..1936e37f 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -1,4 +1,5 @@ .. _cmd: +.. highlight:: console =========================== Coverage Command Line usage @@ -56,10 +57,9 @@ If you want to measure that code as well as your own, add the -L flag. Combining Data Files -------------------- -For some applications, your code will run on a number of different machines. -To make it easier to collect together the .coverage data files from these runs, -the -p flag will append a machine name and process id to the .coverage data file -name. +If you need to collect coverage data from different machines, coverage can +combine multiple files into one for reporting. Use the -p flag during execution +to append a machine name and process id to the .coverage data file name. Once you have created a number of these files, you can copy them all to a single directory, and use the -c flag to combine them into one .coverage data file:: @@ -127,3 +127,4 @@ decorated to show the status of each line. Annotation ---------- +text annotation too! diff --git a/doc/index.rst b/doc/index.rst index d28e7a79..68472c2a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -34,12 +34,16 @@ Getting started with coverage.py is easy: #. Install coverage.py from the
`coverage page on the cheeseshop <http://pypi.python.org/pypi/coverage>`_.
-#. Run coverage.py to execute your program and gather data::
+#. Run coverage.py to execute your program and gather data:
+
+ .. code-block:: console
$ coverage -e -x my_program.py arg1 arg2
blah blah ..your program's output.. blah blah
-#. Run coverage.py to report on the results::
+#. Run coverage.py to report on the results:
+
+ .. code-block:: console
$ coverage -r -m
Name Stmts Exec Cover Missing
@@ -50,7 +54,9 @@ Getting started with coverage.py is easy: TOTAL 76 66 87%
#. For a nicer presentation, run coverage.py to get annotated HTML listings
- detailing missed lines::
+ detailing missed lines:
+
+ .. code-block:: console
$ coverage -b -i -d htmlcov
@@ -60,7 +66,9 @@ Getting started with coverage.py is easy: Getting Help
~~~~~~~~~~~~
-This is a third-level section, with some XML::
+This is a third-level section, with some XML:
+
+.. code-block:: xml
<tag attr='value'>1 < 2 & 2 > 1</tag>
Whoa!
|