Merge #657

657: Automatically check if README.md examples are working when running "cargo test" r=cuviper a=GuillaumeGomez Since rustdoc nightly now provides "cfg(test)" when running on test mode, we can now use this macro on test mode only to check if README.md examples are working as expected. Co-authored-by: Guillaume Gomez <[email protected]> Co-authored-by: Josh Stone <[email protected]>
rayon-rs · May 1, 2019 · c561af5 · c561af5
2 parents 047ea91 + 93ad831
commit c561af5
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -34,3 +34,4 @@ rand = "0.6"
 rand_xorshift = "0.1"
 serde = "1"
 serde_derive = "1"
+doc-comment = "0.3"
diff --git a/README.md b/README.md
@@ -104,14 +104,14 @@ command to get a visualization of an nbody simulation. To see the
 effect of using Rayon, press `s` to run sequentially and `p` to run in
 parallel.
 
-```
+```text
 > cd rayon-demo
 > cargo run --release -- nbody visualize
 ```
 
 For more information on demos, try:
 
-```
+```text
 > cd rayon-demo
 > cargo run --release -- --help
 ```

diff --git a/rayon-core/src/compile_fail/scope_join_bad.rs b/rayon-core/src/compile_fail/scope_join_bad.rs
@@ -1,4 +1,4 @@
-/*! ```compile_fail,E0597
+/*! ```compile_fail,E0373
 
 fn bad_scope<F>(f: F)
     where F: FnOnce(&i32) + Send,

diff --git a/src/lib.rs b/src/lib.rs
@@ -85,6 +85,12 @@ extern crate rayon_core;
 extern crate rand;
 #[cfg(test)]
 extern crate rand_xorshift;
+#[cfg(test)]
+#[macro_use]
+extern crate doc_comment;
+
+#[cfg(test)]
+doctest!("../README.md");
 
 #[macro_use]
 mod delegate;