From: Marco Baringer <mb@bese.it>
Date: Thu, 26 Jan 2006 11:53:38 +0000 (+0100)
Subject: Document what happens when re-evaluating def-suite and make-suite.
X-Git-Url: http://repo.macrolet.net/gitweb/?p=fiveam.git;a=commitdiff_plain;h=503a35c263e4799597e656da5ae088fc678ece48

Document what happens when re-evaluating def-suite and make-suite.
---

diff --git a/src/suite.lisp b/src/suite.lisp
index 0118e1a..bed1945 100644
--- a/src/suite.lisp
+++ b/src/suite.lisp
@@ -20,7 +20,9 @@
   "Define a new test-suite named NAME.
 
 IN (a symbol), if provided, causes this suite te be nested in the
-suite named by IN."
+suite named by IN. NB: This macro is built on top of make-suite,
+as such it, like make-suite, will overrwrite any existing suite
+named NAME."
   `(progn
      (make-suite ',name
 		 ,@(when description `(:description ,description))
@@ -28,7 +30,9 @@ suite named by IN."
      ',name))
 
 (defun make-suite (name &key description in)
-  "Create a new test suite object."
+  "Create a new test suite object.
+
+Overides any existing suite named NAME."
   (let ((suite (make-instance 'test-suite :name name)))
     (when description
       (setf (description suite) description))