diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2009-06-13 16:39:37 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-06-13 16:39:37 -0400 |
commit | 92fd89923847f40a981224f0782caa6edd9a7f06 (patch) | |
tree | 772004948a2c0dc4180ac1e1a90101154503dfef /doc/faq.rst | |
parent | 782a37813ba18cd01f340eeb18fd01f7860a9a63 (diff) | |
download | python-coveragepy-92fd89923847f40a981224f0782caa6edd9a7f06.tar.gz |
Finish up the docs.
Diffstat (limited to 'doc/faq.rst')
-rw-r--r-- | doc/faq.rst | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/faq.rst b/doc/faq.rst new file mode 100644 index 0000000..364ed99 --- /dev/null +++ b/doc/faq.rst @@ -0,0 +1,55 @@ +.. _faq: + +================== +FAQ and Other Help +================== + +:history: 20090613T141800, brand new docs. + +Frequently Asked Questions +-------------------------- + +**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. + +Use the -e switch on the command line to 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. + +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. + +**Q: Does coverage work on Python 3.0?** + +Not yet, but that's next on my list. + +**Q: Isn't coverage testing the best thing ever?** + +It's good, but `it isn't perfect +<http://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html>`_. + + +Getting More Help +----------------- + +You can discuss coverage or get help using it on the `Testing In Python +<http://lists.idyll.org/listinfo/testing-in-python>`_ mailing list. + +Bug reports are gladly accepted at the `bitbucket issue tracker +<http://bitbucket.org/ned/coveragepy/issues/>`_. + +Lastly, `I can be reached <http://nedbatchelder.com/site/aboutned.html>`_ in a +number of ways. |