Skip to content

Commit eb1b827

Browse files
Port CLJ-2225: Improve docstrings of assert and *assert*
Co-authored-by: Alex Miller <alex.miller@cognitect.com>
1 parent 40f7f6b commit eb1b827

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

src/main/cljs/cljs/core.cljs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@
6969
*out* nil)
7070

7171
(def
72-
^{:dynamic true}
72+
^{:dynamic true
73+
:doc "When set to logical false, 'assert' will omit assertion checks in
74+
compiled code. Defaults to true."}
7375
*assert* true)
7476

7577
(defonce

src/main/clojure/cljs/core.cljc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2479,8 +2479,11 @@
24792479
(core/when *assert* x))
24802480

24812481
(core/defmacro assert
2482-
"Evaluates expr and throws an exception if it does not evaluate to
2483-
logical true."
2482+
"Evaluates expression x and throws an exception with optional
2483+
message if x does not evaluate to logical true.
2484+
2485+
Assertion checks are omitted from compiled code if '*assert*' is
2486+
false."
24842487
([x]
24852488
(core/when *assert*
24862489
`(when-not ~x

0 commit comments

Comments
 (0)