Skip to content

Commit

Permalink
Update options for codox
Browse files Browse the repository at this point in the history
  • Loading branch information
apa512 committed May 10, 2016
1 parent a920a1e commit a8ff4af
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A RethinkDB client for Clojure. Tested and supported on RethinkDB 2.0.x but shou

## Changes

All changes are published in the [CHANGELOG](CHANGELOG.md). Of particular note, 0.10.x is the last release track supporting Clojure 1.6 and below. 0.11.x is the last release track that supports versions of RethinkDB < 2.0
All changes are published in the [CHANGELOG](CHANGELOG.md). Of particular note, 0.10.x is the last release track supporting Clojure 1.6 and below. 0.11.x is the last release track that supports versions of RethinkDB < 2.0.

## Usage

Expand Down Expand Up @@ -192,11 +192,10 @@ An example using loops, functions, branching and various object operations (sele
(r/run conn))))
```

Note that for inserts we resolve conflicts by an update. At worst this may override an object that has been added while the query was running. Which should never happen since this function is recognized by RethinkDB as atomic.
Note that for inserts we resolve conflicts by an update. At worst this may override an object that has been added while the query was running, which should never happen since this function is recognized by RethinkDB as atomic.

Also note that the ordering in `r/merge` is important, preference is given to fields in the rightmost object in the argument list. The upsert'd items can define a default `:updated` and `:created` field that'll override `(r/now)`.

### Complete Reference

See full documentation at http://apa512.github.io/clj-rethinkdb/ (work in progress).

5 changes: 2 additions & 3 deletions project.clj
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
:url "http://github.com/apa512/clj-rethinkdb"
:license {:name "Eclipse Public License"
:url "http://www.eclipse.org/legal/epl-v10.html"}
:codox {:defaults {:doc/format :markdown}
:src-dir-uri "https://github.com/apa512/clj-rethinkdb/blob/master/"
:src-linenum-anchor-prefix "L"}
:codox {:metadata {:doc/format :markdown}
:source-uri "https://github.com/apa512/clj-rethinkdb/blob/master/{filepath}#L{line}"}
:global-vars {*warn-on-reflection* true}
:plugins [[lein-codox "0.9.5"]]
:dependencies [[org.clojure/clojure "1.7.0"]
Expand Down

0 comments on commit a8ff4af

Please sign in to comment.