Amends OPEN-STORE/CLOSE-STORE docs.

I hope the patch format is alright, now.
If not, slap me again.

  Leslie
Mon Feb  4 14:18:22 CET 2008  [EMAIL PROTECTED]
  * Amend OPEN-STORE and CLOSE-STORE docs.
--- old-elephant/src/elephant/controller.lisp	2008-02-04 19:58:21.721222296 +0100
+++ new-elephant/src/elephant/controller.lisp	2008-02-04 19:58:21.751217879 +0100
@@ -477,7 +477,7 @@
    controllers yourself.  *store-controller* is a convenience variable for single-store
    applications or single-store per thread apps.  Multi-store apps should either confine
    their *store-controller* to a given dynamic context or wrap each store-specific op in
-   a transaction using with or ensure transaction"
+   a transaction using with or ensure transaction.  Returns the opened store controller."
   (assert (consp spec))
   ;; Ensure that parameters are set
   (initialize-user-parameters)
@@ -490,7 +490,8 @@
 	(setq *store-controller* controller))))
 
 (defun close-store (&optional sc)
-  "Conveniently close the store controller."
+  "Conveniently close the store controller. If you pass a custom store controller,
+  you are responsible for setting it to NIL."
   (when (or sc *store-controller*)
     (close-controller (or sc *store-controller*)))
   (unless sc
_______________________________________________
elephant-devel site list
elephant-devel@common-lisp.net
http://common-lisp.net/mailman/listinfo/elephant-devel

Reply via email to