Skip to content

Commit 8098c40

Browse files
committed
Doc tweaks for 3.5.2
1 parent 9bfa77e commit 8098c40

File tree

3 files changed

+30
-5
lines changed

3 files changed

+30
-5
lines changed

doc/cmd.rst

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Coverage command line usage
1313
:history: 20100725T211700, updated for 3.4
1414
:history: 20110827T212500, updated for 3.5.1, combining aliases
1515
:history: 20120119T075600, Added some clarification from George Paci
16+
:history: 20120504T091800, Added info about execution warnings, and 3.5.2 stuff.
1617

1718
.. highlight:: console
1819

@@ -104,14 +105,31 @@ during measurement. See :ref:`cmd_combining` below.
104105
During execution, coverage.py may warn you about conditions it detects that
105106
could affect the measurement process. The possible warnings include:
106107

107-
* "Trace function changed, measurement is likely wrong"
108+
* "Trace function changed, measurement is likely wrong: XXX"
108109

109-
* "Module has no Python source"
110+
Coverage measurement depends on a Python setting called the trace function.
111+
Other Python code in your product might change that function, which will
112+
disrupt coverage.py's measurement. This warning indicate that has happened.
113+
The XXX in the message is the new trace function value, which might provide
114+
a clue to the cause.
110115

111-
* "Module was never imported"
116+
* "Module XXX has no Python source"
117+
118+
You asked coverage.py to measure module XXX, but once it was imported, it
119+
turned out not to have a corresponding .py file. Without a .py file,
120+
coverage.py can't report on missing lines.
121+
122+
* "Module XXX was never imported"
123+
124+
You asked coverage.py to measure module XXX, but it was never imported by
125+
your program.
112126

113127
* "No data was collected"
114128

129+
Coverage.py ran your program, but didn't measure any lines as executed.
130+
This could be because you asked to measure only modules that never ran,
131+
or for other reasons.
132+
115133

116134

117135
.. _cmd_datafile:
@@ -239,6 +257,10 @@ Lines are highlighted green for executed, red for missing, and gray for
239257
excluded. The counts at the top of the file are buttons to turn on and off
240258
the highlighting.
241259

260+
If you prefer a different style for your HTML report, you can provide your
261+
own CSS file to apply, by specifying a CSS file in the [html] section of the
262+
configuration file. See :ref:`config_html` for details.
263+
242264
A number of keyboard shortcuts are available for navigating the report.
243265
Click the keyboard icon in the upper right to see the complete list.
244266

doc/config.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,8 @@ for example "87%". A value of 2 will display percentages like "87.32%".
165165
show missing lines. See :ref:`cmd_summary` for more information.
166166

167167

168+
.. _config_html:
169+
168170
[html]
169171
------
170172

@@ -175,7 +177,8 @@ also apply to HTML output, where appropriate.
175177

176178
``extra_css`` (string): the path to a file of CSS to apply to the HTML report.
177179
The file will be copied into the HTML output directory. Don't name it
178-
"style.css".
180+
"style.css". This CSS is in addition to the CSS normally used, though you can
181+
overwrite as many of the rules as you like.
179182

180183

181184
[xml]

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ not.
3636
.. ifconfig:: not prerelease
3737

3838
The latest version is coverage.py 3.5.2, released 4 May 2012.
39-
It is supported on Python versions 2.3 through 3.2.
39+
It is supported on Python versions 2.3 through 3.3, and PyPy 1.8.
4040

4141
.. ifconfig:: prerelease
4242

0 commit comments

Comments
 (0)