Skip to content

Commit 2a413d4

Browse files
committed
clarify cljs.test/run-tests docstring
1 parent e962ec0 commit 2a413d4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/main/cljs/cljs/test.clj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,10 @@
281281

282282
(defmacro run-tests
283283
"Runs all tests in the given namespaces; prints results.
284-
Defaults to current namespace if none given."
284+
Defaults to current namespace if none given. Does not return a meaningful
285+
value due to the possiblity of asynchronous execution. To detect test
286+
completion add a :end-run-tests method case to the cljs.test/report
287+
multimethod."
285288
([] `(run-tests (cljs.test/empty-env) '~ana/*cljs-ns*))
286289
([env-or-ns]
287290
(if (ns? env-or-ns)

0 commit comments

Comments
 (0)