fix bug in DFS, added rooted-dfs, improved docstring for find-vertex-between-edges-if

[cl-graph.git] / dev / api.lisp

diff --git a/dev/api.lisp b/dev/api.lisp
index f5d836c..332b881 100644 (file)
--- a/dev/api.lisp
+++ b/dev/api.lisp
@@ -622,10 +622,11 @@ as a source. [?? Could be a defun]."))
 
 (defgeneric find-edge-between-vertexes-if
   (graph value-or-vertex-1 value-or-vertex-2 fn &key error-if-not-found?)
-  (:documentation "Finds and returns an edge between value-or-vertex-1
-  and value-or-vertex-2 if one exists. Unless error-if-not-found? is
-  nil, then a error will be signaled. [?? Error not signal, need
-  test.]"))
+  (:documentation 
+   "Finds and returns an edge between value-or-vertex-1
+and value-or-vertex-2 which returns true (as a generalized boolean) when
+evaluated by `fn`. Unless error-if-not-found? is nil, then a error will 
+be signaled. [?? IS error really signaled? need a test.]"))
 
 (defgeneric vertices-share-edge-p (vertex-1 vertex-2)
   (:documentation "Return true if vertex-1 and vertex-2 are connected