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

Improve doc string of 'completion-at-point-functions'

Browse source 
* lisp/minibuffer.el (completion-at-point-functions): Doc fix.
(Bug#24663)
This commit is contained in:
Eli Zaretskii 2016-10-13 20:15:21 +03:00
parent ceb46f0021
commit 4de671d844
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
lisp/minibuffer.el
View file

@ -2052,22 +2052,22 @@ Also respects the obsolete wrapper hook `completion-in-region-functions'.
minor-mode-map-alist)) minor-mode-map-alist))
(defvar completion-at-point-functions '(tags-completion-at-point-function) (defvar completion-at-point-functions '(tags-completion-at-point-function)
"Special hook to find the completion table for the thing at point. "Special hook to find the completion table for the entity at point.
Each function on this hook is called in turn without any argument and should Each function on this hook is called in turn without any argument and
return either nil to mean that it is not applicable at point, should return either nil, meaning it is not applicable at point,
or a function of no argument to perform completion (discouraged), or a function of no arguments to perform completion (discouraged),
or a list of the form (START END COLLECTION . PROPS) where or a list of the form (START END COLLECTION . PROPS), where:
START and END delimit the entity to complete and should include point, START and END delimit the entity to complete and should include point,
COLLECTION is the completion table to use to complete it, and COLLECTION is the completion table to use to complete the entity, and
PROPS is a property list for additional information. PROPS is a property list for additional information.
Currently supported properties are all the properties that can appear in Currently supported properties are all the properties that can appear in
`completion-extra-properties' plus: `completion-extra-properties' plus:
`:predicate' a predicate that completion candidates need to satisfy. `:predicate' a predicate that completion candidates need to satisfy.
`:exclusive' If `no', means that if the completion table fails to `:exclusive' value of `no' means that if the completion table fails to
match the text at point, then instead of reporting a completion match the text at point, then instead of reporting a completion
failure, the completion should try the next completion function. failure, the completion should try the next completion function.
As is the case with most hooks, the functions are responsible to preserve As is the case with most hooks, the functions are responsible for
things like point and current buffer.") preserving things like point and current buffer.")
(defvar completion--capf-misbehave-funs nil (defvar completion--capf-misbehave-funs nil
"List of functions found on `completion-at-point-functions' that misbehave. "List of functions found on `completion-at-point-functions' that misbehave.