Skip to content

Commit 95a5b72

Browse files
committed
Noted that it isn't possible to run doctests
1 parent e1897ef commit 95a5b72

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Note that the coverage is deliberately incomplete. That
1010
way you can [follow the badge link][5] and see how [Codecov][1]
1111
works. You can view the code there, see hits and misses for coverage, etc.
1212

13+
**As of July 2, 2016, there is [no option to make rustdoc generate a runnable test executable][rustdoc-executable]. That means that documentation tests will not show in your coverage data. If you discover a way to run the doctest executable with kcov, please open an [Issue][issues] and we will add that to these instructions.**
14+
1315
## Basic Usage
1416

1517
Run your tests with [kcov][6] in order to create the necessary coverage
@@ -130,4 +132,6 @@ learn more about the script.
130132
[4]: https://github.com/codecov/codecov-bash
131133
[5]: http://codecov.io/github/codecov/example-rust?branch=master
132134
[6]: https://simonkagstrom.github.io/kcov/
135+
[rustdoc-executable][http://stackoverflow.com/questions/35547710/does-rustdoc-generate-runnable-binaries]
136+
[issues]: https://github.com/codecov/example-rust/issues
133137

0 commit comments

Comments
 (0)