Skip to content

Commit 1469c56

Browse files
committed
tests: test README.md
Thanks to rust-lang/cargo#383 (comment) for the assist.
1 parent 814d48e commit 1469c56

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ println!("{}", object.id());
1919

2020
Write STAC catalogs using the `BestPracticesRenderer`:
2121

22-
```rust
22+
```rust,no_run
2323
use stac::{Stac, BestPracticesRenderer, Render, Writer, Write};
24-
let (stac, _) = Stac::read("data/catalog.json").unwrap();
25-
let renderer = BestPracticesRenderer::new("a/new/root/directory").unwrap();
24+
let (mut stac, _) = Stac::read("data/catalog.json").unwrap();
25+
let renderer = BestPracticesRenderer::new("a/new/root/directory");
2626
let writer = Writer::default();
2727
stac.write(&renderer, &writer).unwrap();
2828
```

src/lib.rs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,3 +256,17 @@ mod tests {
256256
}
257257
pub(crate) use roundtrip;
258258
}
259+
260+
// From https://github.com/rust-lang/cargo/issues/383#issuecomment-720873790,
261+
// may they be forever blessed.
262+
#[cfg(doctest)]
263+
mod readme {
264+
macro_rules! external_doc_test {
265+
($x:expr) => {
266+
#[doc = $x]
267+
extern "C" {}
268+
};
269+
}
270+
271+
external_doc_test!(include_str!("../README.md"));
272+
}

0 commit comments

Comments
 (0)