aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorscgilardi <scgilardi@gmail.com>2008-04-03 17:08:27 +0000
committerscgilardi <scgilardi@gmail.com>2008-04-03 17:08:27 +0000
commitdbe2d2d4f5ab3c46ad0430b259dbdbec7a0e0b00 (patch)
tree16ee018c7bb59b15d76b6b353ac04a98fe3e2d37
parent430b927cb3ca2e30fdb6a6652db8fbb4f05da5a2 (diff)
pkg.clj: update description of provide
-rw-r--r--pkg.clj21
1 files changed, 9 insertions, 12 deletions
diff --git a/pkg.clj b/pkg.clj
index 9504872b..bbe4438b 100644
--- a/pkg.clj
+++ b/pkg.clj
@@ -11,18 +11,20 @@
;; Clojure package loading and dependency via require/provide.
;;
;; A 'package' is a named set of capabilities represented by a symbol.
-;; Its capabilities are expected to be defined in an implementation
-;; file somewhere in CLASSPATH whose name is the package name followed
-;; by ".clj". The implementation file may be in the filesystem, in a
-;; jar file, or at any other valid CLASSPATH URL.
+;; The capabilities are usually defined in an implementation file
+;; somewhere in CLASSPATH whose name is the package name followed by
+;; ".clj". The implementation file may be in the filesystem, in a jar
+;; file, or at any other valid CLASSPATH URL.
;;
;; A call to 'require' indicates that subsequent code depends on
;; capabilities provided by one or more packages and loads any of those
;; packages that have not already been provided.
;;
-;; A call to 'provide' indicates that a package's capabilities have been
-;; successfully loaded. A package's implementation file will generally
-;; end with a call to provide.
+;; A call to 'provide' records that a package's capabilities are loaded.
+;; By default this is done automatically when 'require' loads the
+;; package's implementation file. 'provide' is also available separately
+;; to allow flexibility in making a package's capabilities available by
+;; some means other than the default.
;;
;; pkg.clj provides variations of 'require' that:
;;
@@ -39,11 +41,6 @@
;;
;; The "force" variations are useful during development.
;;
-;; 'provide' is made available as a separate function (in addition to
-;; being done automatically after loading an implementation file) to allow
-;; flexibility in providing a package's capabilities by some means other
-;; than loading an implementation file using 'require'.
-;;
;; scgilardi (gmail)
;; 2 April 2008
;;