*py-coverage.txt* For Vim version 7.3 Last change: 2012 October 25
+This plugin defines commands and a function, but no key mappings. Following is
+my local configuration, as an example:
+ nnoremap <LocalLeader>mh :PyCoverageHighlight<CR>
+ nnoremap <LocalLeader>mc :PyCoverageClear<CR>
+ nnoremap <LocalLeader>mq :PyCoverageSetQuickfix<CR>
+ nnoremap <LocalLeader>ml :PyCoverageSetLoclist<CR>
+ highlight PyCoverageMissed gui=undercurl guisp=Orange
+If you use the convention of always having your .coverage file at the root of
+your Python projects, then you may want to use an |autocmd| to show coverage
+information on new buffers whenever it's available.
+ autocmd FileType python PyCoverageHighlight
+This will add very little overhead in the case where no .coverage file can be
+found. When coverage data is available, it may take a second for the Python
+coverage tool to generate its report.
These commands all operate on the current buffer. Excepting
|:PyCoverageClear|, they will all call |PyCoverageMissedLines| for the current
-buffer and process the line numbers as appropriate.
+buffer and process the line numbers as appropriate. If coverage data is not
+found for any reason, all commands will behave as if the file has 100%
+coverage (no missed lines).
Uses |matchadd()| to highlight each line in the current buffer that lacks
coverage. This uses the PyCoverageMissed highlight group, which is aliased
+ Reverses |:PyCoverageHighlight|, removing all matches in the
+ PyCoverageMissed group.
+ Populates the quickfix list with the list of missed lines.
+ Populates the current window's location list with the list of missed lines
Returns the |List| of line numbers that lack coverage in the given buffer.
All configuration options have sensible defaults.
Copyright (c) 2012, Peter Sagerson