diff options
| -rw-r--r-- | doc/_static/neds.css | 7 | ||||
| -rw-r--r-- | doc/branch.rst | 16 | ||||
| -rw-r--r-- | doc/changes.rst | 24 | ||||
| -rw-r--r-- | doc/cmd.rst | 1 | ||||
| -rw-r--r-- | doc/excluding.rst | 2 | ||||
| -rw-r--r-- | doc/faq.rst | 24 | ||||
| -rw-r--r-- | doc/index.rst | 2 |
7 files changed, 44 insertions, 32 deletions
diff --git a/doc/_static/neds.css b/doc/_static/neds.css index efcccd4..4d24a68 100644 --- a/doc/_static/neds.css +++ b/doc/_static/neds.css @@ -214,3 +214,10 @@ tt { padding: 0 1px 0 1px; font-size: 0.95em; } + +li { + margin-bottom: 0.4em; +} +ul { + list-style-type: square; +} diff --git a/doc/branch.rst b/doc/branch.rst index 087334b..262ce1a 100644 --- a/doc/branch.rst +++ b/doc/branch.rst @@ -36,17 +36,17 @@ To measure branch coverage, run coverage.py with the ``--branch`` flag:: coverage run --branch myprog.py -When you report on the results with "coverage report" or "coverage html", the -percentage of branch possibilities taken will be included in the percentage -covered total for each file. The coverage percentage for a file is the -actual executions divided by the execution opportunities. Each line in the -file is an execution opportunity, as is each branch destination. +When you report on the results with ``coverage report`` or ``coverage html``, +the percentage of branch possibilities taken will be included in the percentage +covered total for each file. The coverage percentage for a file is the actual +executions divided by the execution opportunities. Each line in the file is an +execution opportunity, as is each branch destination. The HTML report gives information about which lines had missing branches. Lines that were missing some branches are shown in yellow, with an annotation at the far right showing branch destination line numbers that were not exercised. -The XML report produced by "coverage xml" also includes branch information, +The XML report produced by ``coverage xml`` also includes branch information, including separate statement and branch coverage percentages. Each line is annotated with @@ -59,9 +59,11 @@ and destination for each transition from one line to another. Static analysis of the compiled bytecode provides a list of possible transitions. Comparing the measured to the possible indicates missing branches. -The idea of tracking how lines follow each other was from C. Titus Brown. +The idea of tracking how lines follow each other was from `Titus Brown`__. Thanks, Titus! +__ http://ivory.idyll.org/blog + Excluding code -------------- diff --git a/doc/changes.rst b/doc/changes.rst index 11bf07e..97d9a8e 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -12,7 +12,7 @@ Major change history for coverage.py These are the major changes for coverage.py. For a more complete change
-history, see the `CHANGES.txt`_ file.
+history, see the `CHANGES.txt`_ file in the source tree.
.. _CHANGES.txt: http://bitbucket.org/ned/coveragepy/src/tip/CHANGES.txt
@@ -31,7 +31,7 @@ Version 3.2 - XML reporting has file paths that let Cobertura find the source code, fixing
`issue 21`_.
-- The --omit option now works much better than before, fixing `issue 14` and
+- The ``--omit`` option now works much better than before, fixing `issue 14` and
`issue 33`_. Thanks, Danek Duvall.
- The tracer code has changed, it's a few percent faster.
@@ -58,10 +58,10 @@ Version 3.1, 4 October 2009 - Coverage.py has a new command line syntax with sub-commands. This expands
the possibilities for adding features and options in the future. The old
- syntax is still supported. Try "coverage help" to see the new commands.
+ syntax is still supported. Try ``coverage help`` to see the new commands.
Thanks to Ben Finney for early help.
-- Added an experimental "coverage xml" command for producing coverage reports
+- Added an experimental ``coverage xml`` command for producing coverage reports
in a Cobertura-compatible XML format. Thanks, Bill Hart.
- Added the ``--timid`` option to enable a simpler slower trace function that
@@ -70,7 +70,7 @@ Version 3.1, 4 October 2009 - HTML reports now display syntax-colored Python source.
-- Added a "coverage debug" command for getting diagnostic information about the
+- Added a ``coverage debug`` command for getting diagnostic information about the
coverage.py installation.
- Source code can now be read from eggs. Thanks, `Ross Lawley`_. Fixes
@@ -95,7 +95,7 @@ Version 3.0.1, 7 July 2009 raised. This is now fixed.
- The coverage.py code itself will now not be measured by coverage.py, and no
- coverage modules will be mentioned in the nose --with-cover plugin.
+ coverage modules will be mentioned in the nose ``--with-cover`` plugin.
- When running source files, coverage.py now opens them in universal newline
mode just like Python does. This lets it run Windows files on Mac, for
@@ -108,8 +108,8 @@ Version 3.0, 13 June 2009 - Coverage is now a package rather than a module. Functionality has been split
into classes.
-- HTML reports and annotation of source files: use the new -b (browser) switch.
- Thanks to George Song for code, inspiration and guidance.
+- HTML reports and annotation of source files: use the new ``-b`` (browser)
+ switch. Thanks to George Song for code, inspiration and guidance.
- The trace function is implemented in C for speed. Coverage runs are now
much faster. Thanks to David Christian for productive micro-sprints and
@@ -119,12 +119,12 @@ Version 3.0, 13 June 2009 - When using the object api (that is, constructing a coverage() object), data
is no longer saved automatically on process exit. You can re-enable it with
- the auto_data=True parameter on the coverage() constructor. The module-level
- interface still uses automatic saving.
+ the ``auto_data=True`` parameter on the coverage() constructor.
+ The module-level interface still uses automatic saving.
- Code in the Python standard library is not measured by default. If you need
- to measure standard library code, use the -L command-line switch during
- execution, or the cover_pylib=True argument to the coverage() constructor.
+ to measure standard library code, use the ``-L`` command-line switch during
+ execution, or the ``cover_pylib=True`` argument to the coverage() constructor.
- API changes:
diff --git a/doc/cmd.rst b/doc/cmd.rst index cfad036..41de00c 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -202,4 +202,3 @@ Diagnostics ----------- The **debug** command shows internal information to help diagnose problems. - diff --git a/doc/excluding.rst b/doc/excluding.rst index 31aa683..1333f5c 100644 --- a/doc/excluding.rst +++ b/doc/excluding.rst @@ -81,5 +81,3 @@ Here's a list of exclusions I've used:: coverage.exclude('raise NotImplementedError') coverage.exclude('if 0:') coverage.exclude('if __name__ == .__main__.:') - - diff --git a/doc/faq.rst b/doc/faq.rst index fceac38..605a2d2 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -56,19 +56,25 @@ Yes, Python 3.1 is fully supported. **Q: Isn't coverage testing the best thing ever?** -It's good, but `it isn't perfect -<http://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html>`_. +It's good, but `it isn't perfect`__. + +__ http://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html Getting more help ----------------- -You can discuss coverage or get help using it on the `Testing In Python -<http://lists.idyll.org/listinfo/testing-in-python>`_ mailing list. +You can discuss coverage.py or get help using it on the `Testing In Python`_ +mailing list. + +.. _Testing In Python: http://lists.idyll.org/listinfo/testing-in-python + +Bug reports are gladly accepted at the `bitbucket issue tracker`_. +Bitbucket also hosts the `code repository`_. + +.. _bitbucket issue tracker: http://bitbucket.org/ned/coveragepy/issues +.. _code repository: http://bitbucket.org/ned/coveragepy -Bug reports are gladly accepted at the `bitbucket issue tracker -<http://bitbucket.org/ned/coveragepy/issues/>`_. Bitbucket also hosts the -`code repository <http://bitbucket.org/ned/coveragepy>`_. +Lastly, `I can be reached`__ in a number of ways. -Lastly, `I can be reached <http://nedbatchelder.com/site/aboutned.html>`_ in a -number of ways. +__ http://nedbatchelder.com/site/aboutned.html diff --git a/doc/index.rst b/doc/index.rst index 8029530..a3cb875 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -99,7 +99,7 @@ More information ----------------
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
cmd
api
|