From: Gary King Date: Fri, 12 Sep 2008 02:03:02 +0000 (-0400) Subject: docstring tweaks to source-edges, target-edges, and friends X-Git-Url: http://repo.macrolet.net/gitweb/?a=commitdiff_plain;h=a419a81fe65c79b62f1b9aef584572f7a21cf294;p=cl-graph.git docstring tweaks to source-edges, target-edges, and friends darcs-hash:20080912020302-3cc5d-d1b10877b9cdc8635ed161dc30c38a70fc345503.gz --- diff --git a/dev/api.lisp b/dev/api.lisp index 38b0eef..421cc81 100644 --- a/dev/api.lisp +++ b/dev/api.lisp @@ -439,17 +439,22 @@ and any other initialization arguments that make sense for the vertex class.")) ;;; --------------------------------------------------------------------------- (defgeneric source-edges (vertex &optional filter) - (:documentation "Returns a list of the source edges of `vertex`. [?? Could be a defun].")) + (:documentation "Returns a list of the source edges of `vertex`. I.e., +the edges that begin at `vertex`.")) ;;; --------------------------------------------------------------------------- (defgeneric target-edges (vertex &optional filter) - (:documentation "Returns a list of the target edges of `vertex`. [?? Could be a defun].")) + (:documentation "Returns a list of the target edges of `vertex`. +I.e., the edges that end at `vertex`.")) ;;; --------------------------------------------------------------------------- (defgeneric child-vertexes (vertex &optional filter) - (:documentation "Returns a list of the vertexes to which `vertex` is connected by an edge and for which `vertex` is the source vertex. If the connecting edge is undirected, then the vertex is always counted as a source. [?? Could be a defun].")) + (:documentation "Returns a list of the vertexes to which `vertex` +is connected by an edge and for which `vertex` is the source vertex. +If the connecting edge is undirected, then the vertex is always +counted as a source. [?? Could be a defun].")) ;;; ---------------------------------------------------------------------------