Merge pull request #327 from leo-ppp/patch-1

Correct documentation of `wrap-run` hooks
lambdaisland · Nov 3, 2022 · 5a64319 · 5a64319
2 parents 935e6ec + a9c4778
commit 5a64319
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/10_hooks.md b/doc/10_hooks.md
@@ -172,10 +172,10 @@ Most of Kaocha's hooks have `pre-` and `post-` variants, but we don't have
 per-test level, in this case you can use `wrap-run` to "wrap" Kaocha's run
 function.
 
-In particular this wraps `kaocha.testable/-run`, so it receives a two argument function (the arguments are testable and test-plan), and should return such a function. `wrap-run` also receives the test-plan directly.
+In particular this wraps `kaocha.testable/-run`, so it receives a two argument function `run` (the arguments are testable and test-plan), and should return such a function.
 
 ``` clojure
-(defn my-wrap-run-hook [run _test-plan]
+(defn my-wrap-run-hook [run]
   (fn [testable test-plan]
     (println "about to run" (:kaocha.testable/id testable))
     (run testable test-plan)))