From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 16 Oct 2015 13:42:11 +0000 (+0300)
Subject: Improve the doc string of 'completion-boundaries'
X-Git-Tag: emacs-25.0.90~1107
X-Git-Url: https://code.delx.au/gnu-emacs/commitdiff_plain/1158df5f677c1c9ac8649910a680c17b53452753

Improve the doc string of 'completion-boundaries'

* lisp/minibuffer.el (completion-boundaries): Rename the argument
TABLE to COLLECTION, for consistency with other high-level
completion functions.  Document how COLLECTION is called if it
is a function.  (Bug#21644)
---

diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el
index 2814d020b8..6123750b0c 100644
--- a/lisp/minibuffer.el
+++ b/lisp/minibuffer.el
@@ -92,18 +92,21 @@
 ;;; Completion table manipulation
 
 ;; New completion-table operation.
-(defun completion-boundaries (string table pred suffix)
-  "Return the boundaries of the completions returned by TABLE for STRING.
+(defun completion-boundaries (string collection pred suffix)
+  "Return the boundaries of text on which COLLECTION will operate.
 STRING is the string on which completion will be performed.
 SUFFIX is the string after point.
+If COLLECTION is a function, it is called with 3 arguments: STRING,
+PRED, and a cons cell of the form (boundaries . SUFFIX).
+
 The result is of the form (START . END) where START is the position
 in STRING of the beginning of the completion field and END is the position
 in SUFFIX of the end of the completion field.
 E.g. for simple completion tables, the result is always (0 . (length SUFFIX))
 and for file names the result is the positions delimited by
 the closest directory separators."
-  (let ((boundaries (if (functionp table)
-                        (funcall table string pred
+  (let ((boundaries (if (functionp collection)
+                        (funcall collection string pred
                                  (cons 'boundaries suffix)))))
     (if (not (eq (car-safe boundaries) 'boundaries))
         (setq boundaries nil))