[net-nittin-irc-cvs] CVS update: net-nittin-irc/utility.lisp

[Erik Enge]

Update of /project/net-nittin-irc/cvsroot/net-nittin-irc
In directory common-lisp.net:/tmp/cvs-serv4404

Modified Files:
	utility.lisp 
Log Message:
adding better docstring for cut-between

Date: Sat Nov 22 14:07:16 2003
Author: eenge

Index: net-nittin-irc/utility.lisp
diff -u net-nittin-irc/utility.lisp:1.3 net-nittin-irc/utility.lisp:1.4
--- net-nittin-irc/utility.lisp:1.3	Fri Nov  7 10:40:19 2003
+++ net-nittin-irc/utility.lisp	Sat Nov 22 14:07:16 2003
@@ -1,4 +1,4 @@
-;;;; $Id: utility.lisp,v 1.3 2003/11/07 15:40:19 eenge Exp $
+;;;; $Id: utility.lisp,v 1.4 2003/11/22 19:07:16 eenge Exp $
 ;;;; $Source: /project/net-nittin-irc/cvsroot/net-nittin-irc/utility.lisp,v $
 
 ;;;; See the LICENSE file for licensing information.
@@ -118,11 +118,16 @@
     (vector first second third fourth)))
 
 (defun cut-between (string start-char end-chars &key (start 0) (cut-extra t))
-  "If start-char is not nil, cut string between start-char and any of
-the end-chars, from start.  If start-char is nil, cut from start until
-any of the end-chars.
-
-If cut-extra is t, we will cut from start + 1 instead of just start."
+  "If `start-char' is not nil, cut string between `start-char' and any
+of the `end-chars', from `start'.  If `start-char' is nil, cut from
+`start' until any of the `end-chars'.
+
+If `cut-extra' is t, we will cut from start + 1 instead of just
+`start'.
+
+When there is no string matching the input parameters `start' and nil
+will be returned, otherwise `end-position' and the string are
+returned."
   (let ((end-position (position-if #'(lambda (char)
                                        (member char end-chars))
                                    string :start (1+ start)))