summaryrefslogtreecommitdiff
path: root/doc/faq.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-07-23 21:22:30 -0400
committerNed Batchelder <ned@nedbatchelder.com>2015-07-23 21:22:30 -0400
commit080e181a8cc21b8e555fa96eaa54762eb2a76c8e (patch)
tree2b60605f7b2d8d57255039d718d238ce4cb0c493 /doc/faq.rst
parentc7d226aa8ba7c8c37fdda5f594b1fff6f073a872 (diff)
downloadpython-coveragepy-git-080e181a8cc21b8e555fa96eaa54762eb2a76c8e.tar.gz
Refer to the project consistenly as coverage.py. #275
Diffstat (limited to 'doc/faq.rst')
-rw-r--r--doc/faq.rst26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/faq.rst b/doc/faq.rst
index 32492532..2bae33d2 100644
--- a/doc/faq.rst
+++ b/doc/faq.rst
@@ -26,10 +26,10 @@ the :ref:`command line <cmd>` to create the reports you need from that data.
**Q: Why do unexecutable lines show up as executed?**
-Usually this is because you've updated your code and run coverage on it again
-without erasing the old data. Coverage records line numbers executed, so the
-old data may have recorded a line number which has since moved, causing
-coverage to claim a line has been executed which cannot be.
+Usually this is because you've updated your code and run coverage.py on it
+again without erasing the old data. Coverage.py records line numbers executed,
+so the old data may have recorded a line number which has since moved, causing
+coverage.py to claim a line has been executed which cannot be.
If you are using the ``-x`` command line action, it doesn't erase first by
default. Switch to the ``coverage run`` command, or use the ``-e`` switch to
@@ -39,18 +39,18 @@ erase all data before starting the next run.
**Q: Why do the bodies of functions (or classes) show as executed, but the def
lines do not?**
-This happens because coverage is started after the functions are defined. The
-definition lines are executed without coverage measurement, then coverage is
-started, then the function is called. This means the body is measured, but
-the definition of the function itself is not.
+This happens because coverage.py is started after the functions are defined.
+The definition lines are executed without coverage measurement, then
+coverage.py is started, then the function is called. This means the body is
+measured, but the definition of the function itself is not.
-To fix this, start coverage earlier. If you use the :ref:`command line <cmd>`
-to run your program with coverage, then your entire program will be monitored.
-If you are using the :ref:`API <api>`, you need to call coverage.start() before
-importing the modules that define your functions.
+To fix this, start coverage.py earlier. If you use the :ref:`command line
+<cmd>` to run your program with coverage.py, then your entire program will be
+monitored. If you are using the :ref:`API <api>`, you need to call
+coverage.start() before importing the modules that define your functions.
-**Q: Coverage is much slower than I remember, what's going on?**
+**Q: Coverage.py is much slower than I remember, what's going on?**
Make sure you are using the C trace function. Coverage.py provides two
implementations of the trace function. The C implementation runs much faster.