diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2012-05-04 09:20:38 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2012-05-04 09:20:38 -0400 |
commit | 8098c4013602869b40a085276758d88deedeff22 (patch) | |
tree | 93ec34f3e5b9089781d300fce5f4125a7890aa3c | |
parent | 9bfa77edbfeb3b7c48885e1dbbc32545ecaa7b51 (diff) | |
download | python-coveragepy-git-8098c4013602869b40a085276758d88deedeff22.tar.gz |
Doc tweaks for 3.5.2
-rw-r--r-- | doc/cmd.rst | 28 | ||||
-rw-r--r-- | doc/config.rst | 5 | ||||
-rw-r--r-- | doc/index.rst | 2 |
3 files changed, 30 insertions, 5 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index a9c00dcc..5b4eb2dc 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -13,6 +13,7 @@ Coverage command line usage :history: 20100725T211700, updated for 3.4 :history: 20110827T212500, updated for 3.5.1, combining aliases :history: 20120119T075600, Added some clarification from George Paci +:history: 20120504T091800, Added info about execution warnings, and 3.5.2 stuff. .. highlight:: console @@ -104,14 +105,31 @@ during measurement. See :ref:`cmd_combining` below. During execution, coverage.py may warn you about conditions it detects that could affect the measurement process. The possible warnings include: -* "Trace function changed, measurement is likely wrong" +* "Trace function changed, measurement is likely wrong: XXX" -* "Module has no Python source" + Coverage measurement depends on a Python setting called the trace function. + Other Python code in your product might change that function, which will + disrupt coverage.py's measurement. This warning indicate that has happened. + The XXX in the message is the new trace function value, which might provide + a clue to the cause. -* "Module was never imported" +* "Module XXX has no Python source" + + You asked coverage.py to measure module XXX, but once it was imported, it + turned out not to have a corresponding .py file. Without a .py file, + coverage.py can't report on missing lines. + +* "Module XXX was never imported" + + You asked coverage.py to measure module XXX, but it was never imported by + your program. * "No data was collected" + Coverage.py ran your program, but didn't measure any lines as executed. + This could be because you asked to measure only modules that never ran, + or for other reasons. + .. _cmd_datafile: @@ -239,6 +257,10 @@ Lines are highlighted green for executed, red for missing, and gray for excluded. The counts at the top of the file are buttons to turn on and off the highlighting. +If you prefer a different style for your HTML report, you can provide your +own CSS file to apply, by specifying a CSS file in the [html] section of the +configuration file. See :ref:`config_html` for details. + A number of keyboard shortcuts are available for navigating the report. Click the keyboard icon in the upper right to see the complete list. diff --git a/doc/config.rst b/doc/config.rst index 5c7f861f..74cab4fd 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -165,6 +165,8 @@ for example "87%". A value of 2 will display percentages like "87.32%". show missing lines. See :ref:`cmd_summary` for more information. +.. _config_html: + [html] ------ @@ -175,7 +177,8 @@ also apply to HTML output, where appropriate. ``extra_css`` (string): the path to a file of CSS to apply to the HTML report. The file will be copied into the HTML output directory. Don't name it -"style.css". +"style.css". This CSS is in addition to the CSS normally used, though you can +overwrite as many of the rules as you like. [xml] diff --git a/doc/index.rst b/doc/index.rst index 78f87c73..9b8d177e 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -36,7 +36,7 @@ not. .. ifconfig:: not prerelease The latest version is coverage.py 3.5.2, released 4 May 2012. - It is supported on Python versions 2.3 through 3.2. + It is supported on Python versions 2.3 through 3.3, and PyPy 1.8. .. ifconfig:: prerelease |