From 83ab0526e9c71e5239fc4233b0ef3a534409244a Mon Sep 17 00:00:00 2001 From: Axel Meyer Date: Sat, 16 May 2026 17:51:54 +0200 Subject: [PATCH] docs(maps-test): add API section documenting run_tests entrypoint Test-libs expose a single public function (run_tests) per ADR-0037. Documenting it under ## API allows --lint to pass cleanly on test-libs, now that parse_readme_api supports namespace-less H3 headers. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index f0c1eaa..ec0c104 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,13 @@ Sporel.exe --libs-dir= --test-libs=lib-core.maps-test Output is TAP version 13 on stdout; exit-code = failure-count (0 = all pass). +## API + +### `run_tests(ctx)` +**Syntax:** `M.run_tests(ctx) → void` (test-lib entrypoint per ADR-0037) + +Executes the test-suite against `lib-core.maps`. Calls `engine.exit(engine.test.failures())` at end; exit-code = failure-count. + ## References - ADR-0037 (Tests-as-Libs Convention)