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

hyperium · Jul 15, 2019 · 192b172 · 192b172
1 parent cece1b8
commit 192b172
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -33,6 +33,7 @@ rand = "0.4"
 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
@@ -163,6 +163,13 @@ extern crate bytes;
 extern crate fnv;
 extern crate itoa;
 
+#[cfg(test)]
+#[macro_use]
+extern crate doc_comment;
+
+#[cfg(test)]
+doctest!("../README.md");
+
 pub mod header;
 pub mod method;
 pub mod request;