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

* lisp/minibuffer.el (completion-table-dynamic): Improve docstring

Browse source
This commit is contained in:
Stefan Monnier 2019-02-18 13:00:44 -05:00
parent 5dc4e51e51
commit d49cdd92fc
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lisp/minibuffer.el
View file

@ -174,10 +174,14 @@ ACTION can be one of nil, t or `lambda'."
(defun completion-table-dynamic (fun &optional switch-buffer) (defun completion-table-dynamic (fun &optional switch-buffer)
"Use function FUN as a dynamic completion table. "Use function FUN as a dynamic completion table.
FUN is called with one argument, the string for which completion is required, FUN is called with one argument, the string for which completion is requested,
and it should return an alist containing all the intended possible completions. and it should return a completion table containing all the intended possible
This alist may be a full list of possible completions so that FUN can ignore completions.
the value of its argument. This table is allowed to include elements that do not actually match the
string: they will be automatically filtered out.
The completion table returned by FUN can use any of the usual formats of
completion tables such as lists, alists, and hash-tables.
If SWITCH-BUFFER is non-nil and completion is performed in the If SWITCH-BUFFER is non-nil and completion is performed in the
minibuffer, FUN will be called in the buffer from which the minibuffer minibuffer, FUN will be called in the buffer from which the minibuffer
was entered. was entered.
@ -185,6 +189,8 @@ was entered.
The result of the `completion-table-dynamic' form is a function The result of the `completion-table-dynamic' form is a function
that can be used as the COLLECTION argument to `try-completion' and that can be used as the COLLECTION argument to `try-completion' and
`all-completions'. See Info node `(elisp)Programmed Completion'. `all-completions'. See Info node `(elisp)Programmed Completion'.
The completion table returned by `completion-table-dynamic' has empty
metadata and trivial boundaries.
See also the related function `completion-table-with-cache'." See also the related function `completion-table-with-cache'."
(lambda (string pred action) (lambda (string pred action)