Skip to content

Commit 492b3c1

Browse files
committed
Add "generated" docs with codox
1 parent ab9ebdf commit 492b3c1

File tree

10 files changed

+629
-8
lines changed

10 files changed

+629
-8
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![Clojars Project](http://clojars.org/jen/latest-version.svg)](http://clojars.org/jen)
44

5-
A Clojure library that provides a more friendly syntax for defining [test.check](https://github.com/clojure/test.check) generators based on Clojure data structures, inspired by [Prismatic/schema](https://github.com/Prismatic/schema).
5+
jen is a Clojure library that provides a more friendly syntax for defining [test.check](https://github.com/clojure/test.check) generators based on Clojure data structures, inspired by [Prismatic/schema](https://github.com/Prismatic/schema).
6+
7+
Read the [generated reference documentation here](http://holguinj.github.io/jen/doc/), or read on for an overview.
68

79
## motivation
810

@@ -95,8 +97,8 @@ Instead, we have the `with-recursive` macro, which takes a vector of the form `[
9597

9698
(def gen-binary-tree
9799
"A generator for binary trees using jen's `with-recursive` macro"
98-
(with-recursive [btree ;; we'll use btree to refer to this generator recursively
99-
nil] ;; the second part of the vector is the base (non-recursive) case
100+
(jen/with-recursive [btree ;; we'll use btree to refer to this generator recursively
101+
nil] ;; the second part of the vector is the base (non-recursive) case
100102
{:value gen/int
101103
:left btree
102104
:right btree}))

0 commit comments

Comments
 (0)