Clarify monger.joda-time's purpose and requirements via docstring
This commit is contained in:
parent
0df0b706df
commit
bc825e4343
1 changed files with 8 additions and 1 deletions
|
|
@ -7,7 +7,14 @@
|
||||||
;; the terms of this license.
|
;; the terms of this license.
|
||||||
;; You must not remove this notice, or any other, from this software.
|
;; You must not remove this notice, or any other, from this software.
|
||||||
|
|
||||||
(ns monger.joda-time
|
(ns ^{:doc "An optional convenience namespaces for applications that heavily use dates and would prefer use JodaTime types
|
||||||
|
transparently when storing and loading them from MongoDB and serializing to JSON.
|
||||||
|
|
||||||
|
Enables automatic conversion of JodaTime date/time/instant instances to JDK dates (java.util.Date) when documents
|
||||||
|
are serialized and the other way around when documents are loaded. Extends clojure.data.json/Write-JSON protocol for
|
||||||
|
JodaTime types.
|
||||||
|
|
||||||
|
To use it, make sure you add dependencies on clj-time (or JodaTime) and clojure.data.json."} monger.joda-time
|
||||||
(:import [org.joda.time DateTime DateTimeZone ReadableInstant]
|
(:import [org.joda.time DateTime DateTimeZone ReadableInstant]
|
||||||
[org.joda.time.format ISODateTimeFormat])
|
[org.joda.time.format ISODateTimeFormat])
|
||||||
(:use [monger.conversion])
|
(:use [monger.conversion])
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue