Doctest the README

TehPers · Aug 13, 2024 · 4a48072 · 4a48072
1 parent 2af3060
commit 4a48072
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -9,11 +9,16 @@ Supports both synchronous and asynchronous assertions.
 use expecters::prelude::*;
 
 #[tokio::test]
-async fn test() {
+async fn test() {    
     expect!(1, as_display, to_equal("1"));
     expect!(1..=5, count, to_equal(5));
 
-    expect!(get_cat_url(0), when_ready, to_contain_substr(".png")).await;
+    expect!(
+        [get_cat_url(0), get_cat_url(5), get_cat_url(42)],
+        all,
+        when_ready,
+        to_end_with(".png"),
+    ).await;
 }
 
 async fn get_cat_url(id: u32) -> String {

diff --git a/src/lib.rs b/src/lib.rs
@@ -98,3 +98,9 @@ pub mod specialization;
 mod macros;
 
 pub use assertions::AssertionOutput;
+
+#[cfg(doctest)]
+#[doc = include_str!("../README.md")]
+mod readme_tests {
+    // Runs doc tests on the readme
+}