[Checkins] SVN: z3c.coverage/trunk/src/z3c/coverage/coveragediff.txt Documentation update.

[Marius Gedminas]

Log message for revision 78197:
  Documentation update.
  
  

Changed:
  U   z3c.coverage/trunk/src/z3c/coverage/coveragediff.txt

-=-
Modified: z3c.coverage/trunk/src/z3c/coverage/coveragediff.txt
===================================================================
--- z3c.coverage/trunk/src/z3c/coverage/coveragediff.txt	2007-07-19 21:06:17 UTC (rev 78196)
+++ z3c.coverage/trunk/src/z3c/coverage/coveragediff.txt	2007-07-19 21:09:59 UTC (rev 78197)
@@ -2,8 +2,10 @@
 ======================
 
 ``coveragediff`` is a tool that can be used to compare two directories with
-coverage reports.  It reports regressions, that is, increases in the number
-of untested code.
+coverage reports (such as the ones produced by ``zope.testing`` test runner
+with the ``--coverage`` option, or, more generally, the ``trace`` module
+from the Python standard library).  ``coveragediff`` reports regressions, that
+is, increases in the number of untested lines of code.
 
 This document describes the internals of ``coveragediff.py``.  It also acts as
 a test suite.
@@ -201,7 +203,8 @@
 ~~~~~~~~~~~~~~~~~~
 
 Report printer can also include links to web pages with the coverage reports
-(e.g. the ones you can get from ``coveragereport``).
+(e.g. the ones you can get from the ``coverage`` tool distributed with
+``z3c.coverage``).
 
     >>> printer = ReportPrinter(web_url='http://example.com/coverage/')
     >>> printer.warn('/tmp/coverage/z3c.coverage.coveragediff.cover',
@@ -262,7 +265,8 @@
 ~~~~~~~~~~~~~~~~~~
 
 Report emailer can also include links to web pages with the coverage reports
-(e.g. the ones you can get from ``coveragereport``).
+(e.g. the ones you can get from the ``coverage`` tool distributed with
+``z3c.coverage``).
 
     >>> emailer = ReportEmailer('Some Bot <bot at example.com>',
     ...                         'Maintainer <m at example.com>',