Skip to content

Commit

Permalink
Clean up some doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
NoahTheDuke committed Nov 21, 2024
1 parent aea2b9e commit 9c66a26
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions src/clojure/lazytest/core.clj
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@
;;; Public API

(defmacro ->ex-failed
"Useful for all expectations. Sets the base
properties on the ExpectationFailed."
"Useful for all expectations. Sets the base properties on the ExpectationFailed."
{:arglists '([expr data]
[&form expr {:keys [message evaluated actual]}])}
([expr data] `(->ex-failed nil ~expr ~data))
Expand Down Expand Up @@ -175,14 +174,13 @@
{:after after-fn#})))

(defmacro around
"Builds a function for the `around` context.
Usage:
(describe some-func
{:context [(around [f]
(binding [*foo* 100]
(f)))]}
...)"
"Builds a function for the `around` context. Works like an anonymous function:
```clojure
(around [f]
(binding [*foo* 100]
(f)))
```"
[param & body]
(assert (and (vector? param)
(= 1 (count param))
Expand All @@ -196,9 +194,9 @@
(defn set-ns-context!
"Add hooks to the namespace suite, instead of to a var or test suite.
`context` must be a sequence of context maps."
[context]
(alter-meta! *ns* assoc :context (ctx/merge-context context)))
`contexts` is a sequence of context maps."
[contexts]
(alter-meta! *ns* assoc :context (ctx/merge-context contexts)))

(def ^:dynamic *context* nil)

Expand Down

0 comments on commit 9c66a26

Please sign in to comment.