Skip to content

Commit eb61e70

Browse files
committed
Tweak documentation for preload plugin.
—Tweak namespace docstring for kaocha.plugin.preloads. —Added note about the ClojureScript limitation to the plugins article..
1 parent c3b4bfb commit eb61e70

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

doc/08_plugins.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,11 @@ Preload namespaces. Useful for loading specs and installing instrumentation.
162162
:kaocha.plugin.preloads/ns-names [my.acme.specs]}
163163
```
164164

165+
This plugin works for only Clojure namespaces. For ClojureScript namespaces, use
166+
the [`:preloads`
167+
functionality](https://cljs.github.io/api/compiler-options/preloads) of the
168+
ClojureScript compiler.
169+
165170
## Debug
166171

167172
Inspect Kaocha's process by printing out a message at every single hook. This is

src/kaocha/plugin/preloads.clj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Useful for preloading specs and other instrumentation.
55
66
This calls `require` on the given namespace names before loading any tests.
7-
Only works for Clojure namespaces, for ClojureScript use the :preloads
8-
functionality of the ClojureScript compiler."
7+
This prlugin works for only Clojure namespaces. For ClojureScript namespaces,
8+
use the :preloads functionality of the ClojureScript compiler."
99
(:require [kaocha.plugin :refer [defplugin]]))
1010

1111
(defplugin kaocha.plugin/preloads

0 commit comments

Comments
 (0)