aboutsummaryrefslogtreecommitdiff
path: root/src/clojure/contrib/pprint.clj
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2009-04-12 00:27:00 +0000
committerTom Faulhaber <git_net@infolace.com>2009-04-12 00:27:00 +0000
commit23c753a2314b293fa899a75bc7d1ac9d212ff666 (patch)
tree1157876a0b2d8f0d6699e0c36c4e3b436a2a9f2b /src/clojure/contrib/pprint.clj
parentfc3d1751bf0b1d059bde100491b9422ef659e7b5 (diff)
Added namespace level documentation
Diffstat (limited to 'src/clojure/contrib/pprint.clj')
-rw-r--r--src/clojure/contrib/pprint.clj12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/clojure/contrib/pprint.clj b/src/clojure/contrib/pprint.clj
index a9198b02..a468470e 100644
--- a/src/clojure/contrib/pprint.clj
+++ b/src/clojure/contrib/pprint.clj
@@ -20,7 +20,17 @@
;; where I the markdown README is currently displayed. I will be moving it into
;; clojure.contrib (either to the wiki or some other document structure) RSN.
-(ns clojure.contrib.pprint
+(ns
+ #^{:doc "This module comprises two elements:
+1) A pretty printer for Clojure data structures, implemented in the function \"pprint\"
+2) A Common Lisp compatible format function, implemented as \"cl-format\" because
+ Clojure is using the name \"format\" for its own format.
+
+The most complete documentation can be found at http://github.com/tomfaulhaber/cl-format
+where I the markdown README is currently displayed. I will be moving it into
+clojure.contrib (either to the wiki or some other document structure) RSN.
+"}
+ clojure.contrib.pprint
(:use clojure.contrib.pprint.utilities)
(:import [clojure.contrib.pprint PrettyWriter]))