[slime-cvs] CVS update: slime/swank.lisp

[Luke Gorrie]

Update of /project/slime/cvsroot/slime
In directory common-lisp.net:/tmp/cvs-serv30423

Modified Files:
	swank.lisp 
Log Message:
Documentation fixes.

Date: Fri Nov 28 15:54:06 2003
Author: lgorrie

Index: slime/swank.lisp
diff -u slime/swank.lisp:1.69 slime/swank.lisp:1.70
--- slime/swank.lisp:1.69	Fri Nov 28 14:54:15 2003
+++ slime/swank.lisp	Fri Nov 28 15:54:02 2003
@@ -1,4 +1,4 @@
-;;;; -*- Mode: lisp; outline-regexp: ";;;;+"; indent-tabs-mode: nil -*-
+;;;; -*- Mode: lisp; outline-regexp: ";;;;;*"; indent-tabs-mode: nil -*-
 ;;;
 ;;; swank.lisp --- the portable bits
 ;;;
@@ -419,7 +419,7 @@
 	  (format nil "~,2F" (/ usecs 1000000.0)))))
 
 
-;;; Macroexpansion
+;;;; Macroexpansion
 
 (defun apply-macro-expander (expander string)
   (let ((*print-pretty* t)
@@ -440,7 +440,7 @@
   (apply-macro-expander #'macroexpand-all string))
 
 
-;;; Completion
+;;;; Completion
 
 (defun case-convert (string)
   "Convert STRING according to the current readtable-case."
@@ -456,9 +456,14 @@
 (defslimefun completions (string default-package-name)
   "Return a list of completions for a symbol designator STRING.  
 
-The result is a list of strings.  If STRING is package qualified the
-result list will also be qualified.  If string is non-qualified the
-result strings are also not qualified and are considered relative to
+The result is the list (COMPLETION-SET
+COMPLETED-PREFIX). COMPLETION-SET is the list of all matching
+completions, and COMPLETED-PREFIX is the best (partial)
+completion of the input string.
+
+If STRING is package qualified the result list will also be
+qualified.  If string is non-qualified the result strings are
+also not qualified and are considered relative to
 DEFAULT-PACKAGE-NAME.
 
 The way symbols are matched depends on the symbol designator's
@@ -533,7 +538,7 @@
     (eq status :external)))
  
 
-;;;; Subword-word matching
+;;;;; Subword-word matching
 
 (defun subword-prefix-p (s1 s2 &key (start1 0) end1 (start2 0))
   "Return true if the subsequence in S1 bounded by START1 and END1
@@ -571,7 +576,7 @@
                                        :start2 start2))))))
 
 
-;;;; Extending the input string by completion
+;;;;; Extending the input string by completion
 
 (defun longest-completion (completions)
   "Return the longest prefix for all COMPLETIONS."
@@ -599,7 +604,8 @@
         (reduce #'common-prefix strings))))
 
 (defun transpose-matrix (matrix)
-  "Turn a matrix (of any sequence type) on its side."
+  "Turn a matrix (of any sequence type) on its side.
+If the rows are of unequal length, truncate uniformly to the shortest."
   ;; A cute function from PAIP p.574
   (if matrix (apply #'mapcar #'list matrix)))