test: fix the readme example and test it (#154)

Instead of manually copying the readme example into an "example" file, doctest the readme directly. fixes #153
multiformats · Jan 8, 2024 · 618ee97 · 618ee97
1 parent 98ce8ff
commit 618ee97
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@
 ## Usage
 
 ```rust
-use cid::multihash::{Code, MultihashDigest};
+use multihash_codetable::{Code, MultihashDigest};
 use cid::Cid;
 use std::convert::TryFrom;
 

diff --git a/examples/readme.rs b/examples/readme.rs
diff --git a/src/lib.rs b/src/lib.rs
@@ -22,6 +22,11 @@ pub use self::version::Version;
 pub use multibase;
 pub use multihash;
 
+// Doctest the readme!
+#[doc = include_str!("../README.md")]
+#[cfg(all(doctest, feature = "std"))]
+pub struct ReadmeDoctest;
+
 /// A Cid that contains a multihash with an allocated size of 512 bits.
 ///
 /// This is the same digest size the default multihash code table has.