exemplary.core
process-all-ns!clj
(process-all-ns! re)Process all loaded namespaces where their name matches the regular expression.
Process all loaded namespaces where their name matches the regular expression.
process-ns!clj
(process-ns!)(process-ns! ns)Runs all vars in a ns through process-var! When given no arguments it will process the current ns.
Runs all vars in a ns through process-var! When given no arguments it will process the current ns.
process-var!clj
(process-var! var)The vars examples will be added to the docstring and the var will become executable by clojure.test. You can use :exemplary.core/examples with a list/vector of examples or :exemplary.core/example with a single example.
When clojure.test/load-tests is false the test metadata will be omitted, only the doc string will be updated.
You must quote your code to ensure it doesn't execute immidiately. So you will have something like one of these in your function params which come after the doc string:
(defn foo "Some info"
{:exemplary.core/example
'(= 10 (+ 5 5))}
[]
:result)
(defn bar "Some info"
{:exemplary.core/examples
'((= 10 (+ 5 5))
(pos? 3))}
[]
:result)
The vars examples will be added to the docstring and the var will become executable by clojure.test. You can use :exemplary.core/examples with a list/vector of examples or :exemplary.core/example with a single example.
When clojure.test/*load-tests* is false the test metadata will be omitted, only the doc string will be updated.
You must quote your code to ensure it doesn't execute immidiately. So you will have something like one of these in your function params which come after the doc string:
```clojure
(defn foo "Some info"
{:exemplary.core/example
'(= 10 (+ 5 5))}
[]
:result)
(defn bar "Some info"
{:exemplary.core/examples
'((= 10 (+ 5 5))
(pos? 3))}
[]
:result)
```cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close