Automatically check if README.md examples are working when running "c…

…argo test"
rust-lang-nursery · Apr 28, 2019 · e519fd4 · e519fd4
1 parent 88994b2
commit e519fd4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -21,6 +21,9 @@ optional = true
 [features]
 spin_no_std = ["spin"]
 
+[dev-dependencies]
+doc-comment = "0.3.1"
+
 [badges]
 appveyor = { repository = "rust-lang-nursery/lazy-static.rs" }
 travis-ci = { repository = "rust-lang-nursery/lazy-static.rs" }

diff --git a/src/lib.rs b/src/lib.rs
@@ -104,6 +104,13 @@ This crate provides one cargo feature:
 #[doc(hidden)]
 pub mod lazy;
 
+#[cfg(test)]
+#[macro_use]
+extern crate doc_comment;
+
+#[cfg(test)]
+doctest!("../README.md");
+
 #[cfg(feature = "spin_no_std")]
 #[path="core_lazy.rs"]
 #[doc(hidden)]