From e519fd42c387957dc8af0606485b811fff7a7078 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Sun, 28 Apr 2019 14:48:16 +0200 Subject: [PATCH] Automatically check if README.md examples are working when running "cargo test" --- Cargo.toml | 3 +++ src/lib.rs | 7 +++++++ 2 files changed, 10 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index ea0ca7a..b9f95ea 100644 --- 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 index 8138848..6ee05e3 100644 --- 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)]