diff options
Diffstat (limited to 'doc/source.rst')
| -rw-r--r-- | doc/source.rst | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/doc/source.rst b/doc/source.rst index e54ff995..18eb706c 100644 --- a/doc/source.rst +++ b/doc/source.rst @@ -30,20 +30,21 @@ 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 in 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``, ``.pyw``, ``.pyo``, or -``.pyc`` will also be skipped. - -.. note:: Modules named as sources may be imported twice, once by coverage.py - to find their location, then again by your own code or test suite. Usually - this isn't a problem, but could cause trouble if a module has side-effects - at import time. +If the source option is specified, only code in 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``, +``.pyw``, ``.pyo``, or ``.pyc`` will also be skipped. + +.. note:: + + Modules named as sources may be imported twice, once by coverage.py to find + their location, then again by your own code or test suite. Usually this + isn't a problem, but could cause trouble if a module has side-effects at + import time. You can further fine-tune coverage.py's attention with the ``--include`` and ``--omit`` switches (or ``[run] include`` and ``[run] omit`` configuration |