summaryrefslogtreecommitdiff
path: root/doc/contributing.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/contributing.rst')
-rw-r--r--doc/contributing.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst
index 23eb1adb..90b9ba1b 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -138,6 +138,20 @@ some warnings. Please try to keep it that way, but don't let pylint warnings
keep you from sending patches. I can clean them up.
+Coverage testing coverage.py
+----------------------------
+
+Coverage.py can measure itself, but it's complicated. The process has been
+packaged up to make it easier::
+
+ $ COVERAGE_COVERAGE=yes tox
+ $ python igor.py combine_html
+
+Then look at htmlcov/index.html. Note that due to the recursive nature of
+coverage.py measuring itself, there are some parts of the code that will never
+appear as covered, even though they are executed.
+
+
Contributing
------------