diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2014-12-17 08:50:16 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2014-12-17 08:50:16 -0500 |
| commit | a6e77b38f2341ae2ff4713119fdcad0bb3515e11 (patch) | |
| tree | d565aa7fdab2fd27a7944a7f822e34193f604a73 | |
| parent | 149e76b9dfd4801ee752cef5513b88e408bf7119 (diff) | |
| download | python-coveragepy-git-a6e77b38f2341ae2ff4713119fdcad0bb3515e11.tar.gz | |
Clarify what files are considered by --source.
| -rw-r--r-- | doc/source.rst | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/source.rst b/doc/source.rst index ec9994b1..2b16198f 100644 --- a/doc/source.rst +++ b/doc/source.rst @@ -30,7 +30,10 @@ 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. 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. +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, and files with unusual punctuation in their names will be skipped +(they are assumed to be scratch files written by text editors). You can further fine-tune coverage.py's attention with the ``--include`` and ``--omit`` switches (or ``[run] include`` and ``[run] omit`` configuration |