Skip to content

Commit

Permalink
More duplicate the description about doctests
Browse files Browse the repository at this point in the history
This is already described in the other two sections (top-level and
"known limitations" sections), but some users do not notice them.

Closes #244
  • Loading branch information
taiki-e committed Mar 2, 2023
1 parent cd5c5c2 commit c5d3c43
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,8 @@ By default, run tests (via `cargo test`), and print the coverage summary to stdo
cargo llvm-cov
```

Currently, doc tests are disabled by default because nightly-only features are required to make coverage work for doc tests. see [#2] for more.

To run `cargo run` instead of `cargo test`, use `run` subcommand.

```sh
Expand Down

0 comments on commit c5d3c43

Please sign in to comment.