diff options
-rw-r--r-- | doc/_static/neds.css | 13 | ||||
-rw-r--r-- | doc/branch.rst | 3 | ||||
-rw-r--r-- | doc/cmd.rst | 30 | ||||
-rw-r--r-- | doc/faq.rst | 4 |
4 files changed, 37 insertions, 13 deletions
diff --git a/doc/_static/neds.css b/doc/_static/neds.css index 102de98b..efcccd45 100644 --- a/doc/_static/neds.css +++ b/doc/_static/neds.css @@ -24,13 +24,15 @@ body { } div.document { - background-color: #1c4e63; + background-color: #808080; } div.body { background-color: #ffffff; color: #000000; padding: 0 20px 30px 20px; + max-width: 650px; + margin-left: 150px; } div.footer { @@ -129,7 +131,7 @@ div.body h6 { margin: 1em 0; } -div.body h1 { margin-top: 0; font-size: 100%; } +div.body h1 { margin-top: 0; padding-top: 1em; font-size: 150%; } div.body h2 { font-size: 100%; } /* H3's are run-in with the text. */ div.body h3 { @@ -143,6 +145,13 @@ div.body h4 { font-size: 120%; } div.body h5 { font-size: 110%; } div.body h6 { font-size: 100%; } +table.field-list { + margin-left: 300px; + color: #888; + font-style: italic; + font-size: 80%; +} + a.headerlink { color: #c60f0f; font-size: 0.8em; diff --git a/doc/branch.rst b/doc/branch.rst index 1966b45d..28e8c778 100644 --- a/doc/branch.rst +++ b/doc/branch.rst @@ -4,6 +4,9 @@ Branch coverage measurement =========================== +:history: 20091127T201300, new for version 3.2 + + Coverage.py now supports branch coverage measurement. Where a line in your program could jump to more than one next line, coverage.py tracks which of those destinations are actually visited, and flags lines that haven't visited diff --git a/doc/cmd.rst b/doc/cmd.rst index 9c0d4119..4c7db3b9 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -11,9 +11,9 @@ Coverage command line usage .. highlight:: console -When you install coverage, a command-line script called coverage is placed in -your Python scripts directory. Coverage has a number of commands which -determine the action performed: +When you install coverage.py, a command-line script simply called coverage is +placed in your Python scripts directory. Coverage has a number of commands +which determine the action performed: * **run** -- Run a Python program and collect execution data. @@ -21,6 +21,8 @@ determine the action performed: * **html** -- Produce annotated HTML listings with coverage results. +* **xml** -- Produce an XML report with coverage results. + * **erase** -- Erase previously collected coverage data. * **combine** -- Combine together a number of data files. @@ -43,14 +45,18 @@ coverage command:: blah blah ..your program's output.. blah blah Your program runs just as if it had been invoked with the Python command line. -Arguments after your file name are passed to your program in sys.argv. +Arguments after your file name are passed to your program in ``sys.argv``. + +If you want :ref:`branch coverage <branch>` measurement, use the ``--branch`` +flag. Otherwise only statement coverage is measured. -By default, coverage does not measure code installed with the Python interpreter. -If you want to measure that code as well as your own, add the ``-L`` flag. +By default, coverage does not measure code installed with the Python +interpreter. If you want to measure that code as well as your own, add the +``-L`` flag. If your coverage results seems to be overlooking code that you know has been executed, try running coverage again with the ``--timid`` flag. This uses a -simpler but slower trace method. Projects that use DecoratorTools, including +simpler but slower trace method. Projects that use DecoratorTools, including TurboGears, will need to use ``--timid`` to get correct results. This option can also be enabled by setting the environment variable COVERAGE_OPTIONS to ``--timid``. @@ -141,7 +147,9 @@ and which were not. The **html** command creates an HTML report similar to the **report** summary, but as an HTML file. Each module name links to the source file decorated to show the status of each line. -Here's a `sample report </code/coverage/sample_html/index.html>`_. +Here's a `sample report`__. + +__ /code/coverage/sample_html/index.html Lines are highlighted green for executed, red for missing, and gray for excluded. The counts at the top of the file are buttons to turn on and off @@ -184,11 +192,13 @@ XML reporting ------------- The **xml** command writes coverage data to a "coverage.xml" file in a format -compatible with `Cobertura <http://cobertura.sourceforge.net>`_. This command -is still experimental. I need feedback from users to finish it up. +compatible with `Cobertura`_. This command is still experimental. + +.. _Cobertura: http://cobertura.sourceforge.net Diagnostics ----------- The **debug** command shows internal information to help diagnose problems. + diff --git a/doc/faq.rst b/doc/faq.rst index b65a77ab..fceac38f 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -6,6 +6,8 @@ FAQ and other help :history: 20090613T141800, brand new docs. :history: 20091005T073900, updated for 3.1. +:history: 20091127T201500, updated for 3.2. + Frequently asked questions -------------------------- @@ -49,7 +51,7 @@ importing the modules that define your functions. **Q: Does coverage.py work on Python 3.x?** -Yes, as of coverage.py 3.1, Python 3.1 is supported. +Yes, Python 3.1 is fully supported. **Q: Isn't coverage testing the best thing ever?** |