[site] add note about doctests to the homepage

nextest-rs · Apr 26, 2022 · f4043b1 · f4043b1
1 parent f7414f0
commit f4043b1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/site/src/README.md b/site/src/README.md
@@ -31,6 +31,8 @@ cargo nextest run
 
 For more detailed installation instructions, see [Installation](book/installation.md).
 
+> Note: Doctests are currently [not supported](https://github.com/nextest-rs/nextest/issues/16) because of limitations in stable Rust. For now, run doctests in a separate step with `cargo test --doc`.
+
 ## Crates in this project
 
 | Crate | crates.io | rustdoc (latest version) | rustdoc (main) |

diff --git a/site/src/book/listing.md b/site/src/book/listing.md
@@ -10,7 +10,7 @@ cargo nextest list
 
 ![Output of cargo nextest list](../static/nextest-list.png)
 
-[^doctest]: Doctests are currently [not supported](https://github.com/nextest-rs/nextest/issues/16) because of limitations in stable Rust.
+[^doctest]: Doctests are currently [not supported](https://github.com/nextest-rs/nextest/issues/16) because of limitations in stable Rust. For now, run doctests in a separate step with `cargo test --doc`.
 
 ## Options and arguments
 

diff --git a/site/src/book/running.md b/site/src/book/running.md
@@ -60,7 +60,8 @@ cargo nextest run --no-capture
 
 In this mode, cargo-nextest will run tests *serially* so that output from different tests isn't interspersed. This is different from `cargo test -- --nocapture`, which will run tests in parallel.
 
-[^doctest]: Doctests are currently [not supported](https://github.com/nextest-rs/nextest/issues/16) because of limitations in stable Rust.
+[^doctest]: Doctests are currently [not supported](https://github.com/nextest-rs/nextest/issues/16) because of limitations in stable Rust. For now, run doctests in a separate step with `cargo test --doc`.
+
 
 ## Options and arguments