Clarify monger.joda-time's purpose and requirements via docstring

This commit is contained in:
Michael S. Klishin 2012-08-23 09:04:45 +04:00
parent 0df0b706df
commit bc825e4343

View file

@ -7,7 +7,14 @@
;; the terms of this license.
;; 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]
[org.joda.time.format ISODateTimeFormat])
(:use [monger.conversion])