aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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]))