[funds-cvs] r158 - trunk/funds/src/trees

[abaine at common-lisp.net]

Author: abaine
Date: Sun Aug 19 12:14:01 2007
New Revision: 158

Modified:
   trunk/funds/src/trees/tree-insert.lisp
Log:
Edited documentation of tree-insert.

Modified: trunk/funds/src/trees/tree-insert.lisp
==============================================================================
--- trunk/funds/src/trees/tree-insert.lisp	(original)
+++ trunk/funds/src/trees/tree-insert.lisp	Sun Aug 19 12:14:01 2007
@@ -19,11 +19,12 @@
 
 (defgeneric tree-insert (tree key value &key test order)
   (:documentation 
-"A new tree similar to the given tree except that the given key and value
-are now associated with one another.  If the given key is already contained
-in the tree, according to the test function, then the old value is replaced
-by the specified value.  The order function specifies whether the given 
-key-value pair should be inserted to the left or right of the given tree."))
+   "A new tree similar to the given tree except that the given key and 
+value are now associated with one another.  If the given key is already 
+contained in the tree, according to the test function, then the old value 
+is replaced by the specified value in the returned tree.  The order function
+specifies whether the given key-value pair should be inserted to the left or 
+right of the given tree.  The given tree is not modified."))
 
 (defmethod tree-insert ((tree bt-leaf) key value &key test order)
   (declare (ignore test order))