From a6e77b38f2341ae2ff4713119fdcad0bb3515e11 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Wed, 17 Dec 2014 08:50:16 -0500 Subject: Clarify what files are considered by --source. --- doc/source.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'doc') 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 -- cgit v1.2.1