diff options
Diffstat (limited to 'doc/source.rst')
| -rw-r--r-- | doc/source.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/source.rst b/doc/source.rst index 9ca544ab..882befb3 100644 --- a/doc/source.rst +++ b/doc/source.rst @@ -27,17 +27,17 @@ 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 comma- or -newline-separated list of directories or importable names (packages or modules). - -If the source option is specified, only -code those locations 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. Only -importable files (ones at the root of the tree, or in directories with a -``__init__.py`` file) will be considered. Files with unusual punctuation in -their names will be skipped (they are assumed to be scratch files written by -text editors). Files that do not end with ``.py`` or ``.pyo`` or ``.pyc`` -will also be skipped. +newline-separated list of directories or importable names (packages or +modules). + +If the source option is specified, only code those locations 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. Only importable files (ones at the root of the tree, or in directories +with a ``__init__.py`` file) will be considered. Files with unusual punctuation +in their names will be skipped (they are assumed to be scratch files written by +text editors). Files that do not end with ``.py`` or ``.pyo`` or ``.pyc`` will +also be skipped. You can further fine-tune coverage.py's attention with the ``--include`` and ``--omit`` switches (or ``[run] include`` and ``[run] omit`` configuration |