procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve the doc string of 'completion-boundaries'

Browse source 
* 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)
This commit is contained in:
Eli Zaretskii 2015-10-16 16:42:11 +03:00
parent 3f24a31fb7
commit 1158df5f67
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
lisp/minibuffer.el
View file

@ -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))