Liking cljdoc? Tell your friends :D

exemplary.core


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.
sourceraw docstring

process-var!clj

(process-var! var)

The vars examples will be added to the docstring and clojure.test/deftest calls will be created for you within the current namespace. You can use :exemplary.core/examples with a list/vector of examples or :exemplary.core/example with a single example.

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 clojure.test/deftest calls will be created for you within the current namespace. You can use :exemplary.core/examples with a list/vector of examples or :exemplary.core/example with a single example.

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)
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close