Automatically test code examples in the README file (#314)

hyperium · Nov 25, 2019 · fd84409 · fd84409
1 parent 8a3361f
commit fd84409
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -37,6 +37,7 @@ rand = "0.7.0"
 seahash = "3.0.5"
 serde = "1.0"
 serde_json = "1.0"
+doc-comment = "0.3"
 
 [[bench]]
 name = "header_map"

diff --git a/src/lib.rs b/src/lib.rs
@@ -160,6 +160,13 @@
 
 #![deny(warnings, missing_docs, missing_debug_implementations)]
 
+#[cfg(test)]
+#[macro_use]
+extern crate doc_comment;
+
+#[cfg(test)]
+doctest!("../README.md");
+
 pub mod header;
 pub mod method;
 pub mod request;