diff options
author | scgilardi <scgilardi@gmail.com> | 2008-08-19 14:19:14 +0000 |
---|---|---|
committer | scgilardi <scgilardi@gmail.com> | 2008-08-19 14:19:14 +0000 |
commit | a71bf6779c1d62c93dc9db56a6cbf2bb9a7e48ea (patch) | |
tree | 3dc18bebfd1a9972ffbd53fc95a008defe8b7809 | |
parent | a7eaa3f1e012e0f228771cd047984ee8b202e326 (diff) |
transition/lib.clj: refine comments, doc strings
-rw-r--r-- | transition/lib.clj | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/transition/lib.clj b/transition/lib.clj index 32dfed54..03111c19 100644 --- a/transition/lib.clj +++ b/transition/lib.clj @@ -10,17 +10,17 @@ ;; ;; A 'lib' is a named set of resources in classpath whose contents define ;; a library of Clojure code. Lib names are symbols and each lib is -;; associated with the Clojure namespace and the Java package that share -;; its name. A lib's name also locates its root directory within classpath +;; associated with a Clojure namespace and a Java package that share its +;; name. A lib's name also locates its root directory within classpath ;; using Java's package name to classpath-relative path mapping. All ;; resources in a lib should be contained in the directory structure under -;; its root directory. All definitions the lib makes should be in the -;; lib's namespace. +;; its root directory. All definitions a lib makes should be in its +;; associated namespace. ;; ;; Clojure loads a lib by loading its root resource. The root resource ;; path is derived from the root directory path by repeating its last ;; component and appending '.clj'. For example, the lib 'x.y.z has root -;; directory <classpath>/x/y/z'; root resource '<classpath>/x/y/z/z.clj. +;; directory <classpath>/x/y/z; root resource <classpath>/x/y/z/z.clj. ;; The root resource should contain code to create the lib's namespace and ;; load any additional lib resources. ;; @@ -241,17 +241,16 @@ A 'lib' is a named set of resources in classpath whose contents define a library of Clojure code. Lib names are symbols and each lib is associated - with the Clojure namespace and the Java package that share its name. A - lib's name also locates its root directory within classpath using Java's + with a Clojure namespace and a Java package that share its name. A lib's + name also locates its root directory within classpath using Java's package name to classpath-relative path mapping. All resources in a lib - should be contained in the directory structure under its root - directory. All definitions the lib makes should be in the lib's - namespace. + should be contained in the directory structure under its root directory. + All definitions a lib makes should be in its associated namespace. 'require loads a lib by loading its root resource. The root resource path is derived from the root directory path by repeating its last component and appending '.clj'. For example, the lib 'x.y.z has root directory - <classpath>/x/y/z'; root resource '<classpath>/x/y/z/z.clj. The root + <classpath>/x/y/z; root resource <classpath>/x/y/z/z.clj. The root resource should contain code to create the lib's namespace and load any additional lib resources. |