Skip to content

Commit

Permalink
README: add caveats
Browse files Browse the repository at this point in the history
  • Loading branch information
blueyed committed Oct 7, 2017
1 parent 80fda9d commit 6da2de5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ coverage reporting platforms like <https://codecov.io/> or
Neomake](https://github.com/neomake/neomake/pull/1600) (Neomake's test
setup is rather advanced, so do not let that scare you!)

## Caveats

- Vim fails to cover profiling information for the first line of a
script. A workaround is to actually document your file with a top-level
comment.

See https://github.com/Vimjas/covimerage/issues/1 /
https://github.com/vim/vim/issues/2103.

## Links

- Discussion in Coverage.py's issue tracker:
Expand Down

0 comments on commit 6da2de5

Please sign in to comment.