4 ms·
The README.md isn't part of the rust code, so it's not checked by this unless you use tools to generate your README from doc comments like https://github.com/li
by Omin 5y ago
The README.md isn't part of the rust code, so it's not checked by this unless you use tools to generate your README from doc comments like https://github.com/livioribeiro/cargo-readme https://github.com/livioribeiro/cargo-readme.
- Rompect 5y agoActually, it's possible and even frequently used, for example in lazy-static, through the `doc_comment` crate. #[cfg(doctest)] #[macro_use] extern crate doc_comment; #[cfg(doctest)] doctest!("../README.md"); Now, the readme examples are tested like everything else. https://github.com/rust-lang-nursery/lazy-static.rs/blob/master/src/lib.rs#L105 https://github.com/rust-lang-nursery/lazy-static.rs/blob/mas...