summaryrefslogtreecommitdiff
path: root/doc/source.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2010-09-03 23:15:20 -0400
committerNed Batchelder <ned@nedbatchelder.com>2010-09-03 23:15:20 -0400
commit023f6b5f6789230d7dc473361d75505bf86c60f3 (patch)
treef81172151cfcdc5efb3d9f0507c81a2f6faf49f5 /doc/source.rst
parentf03f6c7869be91a754db9b82cc1b7152a86352c6 (diff)
downloadpython-coveragepy-023f6b5f6789230d7dc473361d75505bf86c60f3.tar.gz
Now completely unexecuted source files can be included in reporting. Specifying --source tells coverage.py where to search for files that haven't been executed.
Diffstat (limited to 'doc/source.rst')
-rw-r--r--doc/source.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/source.rst b/doc/source.rst
index e39090a..3f0a156 100644
--- a/doc/source.rst
+++ b/doc/source.rst
@@ -28,7 +28,9 @@ all code, unless it is part of the Python standard library.
You can specify source to measure with the ``--source`` command-line switch,
or the ``[run] source`` configuration value. The value is a list of directories
or package names. If specified, only source inside these directories or
-packages will be measured.
+packages will be measured. Specifying the source option also enables
+coverage.py to report on unexecuted files, since it can search the source tree
+for files that haven't been measured at all.
You can further fine-tune coverage.py's attention with the ``--include`` and
``--omit`` switches (or ``[run] include`` and ``[run] omit`` configuration
@@ -72,4 +74,3 @@ reporting.
Note that these are ways of specifying files to measure. You can also exclude
individual source lines. See :ref:`excluding` for details.
-