(bind definition & forms)Binds the output of forms to the given vars, returning it.
Is evaluated in a test-comment context.
Binds the output of `forms` to the given vars, returning it. Is evaluated in a `test-comment` context.
(effect & forms)Evaluates forms for a side effect, also in a test-comment context.
Evaluates `forms` for a side effect, also in a `test-comment` context.
Expands the form in a test-comment context,
dispatching on the symbolic representation of the head
if it resolves to a var.
Note that if no var is resolved, the form is simply ignored.
Also note that expansion isn't to a fixpoint like with macros;
to trigger another expansion, you must call expand-in-test-comment manually,
and to propagate the expansion to subforms you'll need to use expand-test-comment-forms.
Expands the form in a `test-comment` context, dispatching on the symbolic representation of the head if it resolves to a var. Note that if no var is resolved, the form is simply ignored. Also note that expansion isn't to a fixpoint like with macros; to trigger another expansion, you must call `expand-in-test-comment` manually, and to propagate the expansion to subforms you'll need to use `expand-test-comment-forms`.
(expand-test-comment-forms forms)Expands forms in a test-comment context, discarding nil expansions.
Returns nil if no form expands into anything meaningful.
Expands `forms` in a `test-comment` context, discarding `nil` expansions. Returns `nil` if no form expands into anything meaningful.
(remove-all-tests!)(remove-all-tests! the-ns)Removes all tests in the namespace, defaulting to *ns*.
Removes all tests in the namespace, defaulting to `*ns*`.
(test-comment test-name [form-head & comment-forms :as wrapped-form])Wraps a comment form, expanding into a deftest with the given test-name.
Wraps a `comment` form, expanding into a `deftest` with the given `test-name`.
(value form & body)Like values but anaphorically binds to it, and returns the single value bound to :value
rather than a :values map.
Errors out if it is already bound.
Like `values` but anaphorically binds to `it`, and returns the single value bound to `:value` rather than a `:values` map. Errors out if `it` is already bound.
(values [& bindings] & body)Behaves like a let, but returns a map where :result is bound to the value of the last form in body,
and :values is bound to a map from the symbols in the left hand sides of the bindings to their value.
In a test-comment context, behaves like a let that evaluates its body in a test-comment context.
Behaves like a `let`, but returns a map where `:result` is bound to the value of the last form in `body`, and `:values` is bound to a map from the symbols in the left hand sides of the bindings to their value. In a `test-comment` context, behaves like a `let` that evaluates its body in a `test-comment` context.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |