diff options
Diffstat (limited to 'doc/cmd.rst')
| -rw-r--r-- | doc/cmd.rst | 37 |
1 files changed, 34 insertions, 3 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index 4d49e3f0..0a9f0f68 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -128,8 +128,39 @@ decorated to show the status of each line. Here's a `sample report </code/coverage/sample_html/index.html>`_. +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. -Annotation ----------- +The -d argument to specify an output directory is required:: -text annotation too! + $ coverage -b -d covhtml + + +Text Annotation +--------------- + +The -a flag produces a text annotation of your source code. With a -d argument +specifying an output directory, each Python file becomes a text file in that +directory. Without -d, the files are written into the same directories as the +original Python files. + +Coverage status for each line of source is indicated with a character prefix:: + + > executed + ! missing (not executed) + - excluded + +For example:: + + # A simple function, never called with x==1 + + > def h(x): + """Silly function.""" + - if 0: #pragma: no cover + - pass + > if x == 1: + ! a = 1 + > else: + > a = 2 + |