docs: update README examples and enhance test for README validation

iscc · Aug 12, 2024 · bc13e76 · bc13e76
1 parent f52230a
commit bc13e76
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -61,6 +61,7 @@ Generate a Semantic Text-Code using the create function:
   "iscc": "ISCC:CADV3GG6JH3XEVRNSVYGCLJ7AAV3BOT5J7EHEZKPFXEGRJ2CTWACGZI",
   "characters": 77
 }
+
 ```
 
 poet For granular (per chunk) feature outputs:
@@ -74,13 +75,14 @@ poet For granular (per chunk) feature outputs:
   "characters": 77,
   "features": [
     {
-      "feature": "LWMN4SPXOJLC2",
+      "feature": "XZjeSfdyVi0",
       "offset": 0,
       "size": 77,
       "text": "This is some sample text. It can be a longer document or even an entire book."
     }
   ]
 }
+
 ```
 
 The installation also provides a sct command-line tool:

diff --git a/tests/test_readme.py b/tests/test_readme.py
@@ -5,4 +5,7 @@
 
 
 def test_readme_examples():
-    doctest.testfile(README.as_posix(), module_relative=False, optionflags=doctest.ELLIPSIS)
+    failure_count, test_count = doctest.testfile(
+        README.as_posix(), module_relative=False, optionflags=doctest.ELLIPSIS, raise_on_error=False
+    )
+    assert failure_count == 0, f"{failure_count} out of {test_count} doctests failed"