diff options
| author | Eli Zaretskii | 2016-10-13 20:15:21 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2016-10-13 20:15:21 +0300 |
| commit | 4de671d844c56d70e747366657664c8d293fe2bf (patch) | |
| tree | 302192ac6a312b2e79eca8a831444dca9ce87a4d | |
| parent | ceb46f002145e986c944b2423404535019b7e62b (diff) | |
| download | emacs-4de671d844c56d70e747366657664c8d293fe2bf.tar.gz emacs-4de671d844c56d70e747366657664c8d293fe2bf.zip | |
Improve doc string of 'completion-at-point-functions'
* lisp/minibuffer.el (completion-at-point-functions): Doc fix.
(Bug#24663)
| -rw-r--r-- | lisp/minibuffer.el | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index c7f7c4122c3..56454d5a634 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el | |||
| @@ -2052,22 +2052,22 @@ Also respects the obsolete wrapper hook `completion-in-region-functions'. | |||
| 2052 | minor-mode-map-alist)) | 2052 | minor-mode-map-alist)) |
| 2053 | 2053 | ||
| 2054 | (defvar completion-at-point-functions '(tags-completion-at-point-function) | 2054 | (defvar completion-at-point-functions '(tags-completion-at-point-function) |
| 2055 | "Special hook to find the completion table for the thing at point. | 2055 | "Special hook to find the completion table for the entity at point. |
| 2056 | Each function on this hook is called in turn without any argument and should | 2056 | Each function on this hook is called in turn without any argument and |
| 2057 | return either nil to mean that it is not applicable at point, | 2057 | should return either nil, meaning it is not applicable at point, |
| 2058 | or a function of no argument to perform completion (discouraged), | 2058 | or a function of no arguments to perform completion (discouraged), |
| 2059 | or a list of the form (START END COLLECTION . PROPS) where | 2059 | or a list of the form (START END COLLECTION . PROPS), where: |
| 2060 | START and END delimit the entity to complete and should include point, | 2060 | START and END delimit the entity to complete and should include point, |
| 2061 | COLLECTION is the completion table to use to complete it, and | 2061 | COLLECTION is the completion table to use to complete the entity, and |
| 2062 | PROPS is a property list for additional information. | 2062 | PROPS is a property list for additional information. |
| 2063 | Currently supported properties are all the properties that can appear in | 2063 | Currently supported properties are all the properties that can appear in |
| 2064 | `completion-extra-properties' plus: | 2064 | `completion-extra-properties' plus: |
| 2065 | `:predicate' a predicate that completion candidates need to satisfy. | 2065 | `:predicate' a predicate that completion candidates need to satisfy. |
| 2066 | `:exclusive' If `no', means that if the completion table fails to | 2066 | `:exclusive' value of `no' means that if the completion table fails to |
| 2067 | match the text at point, then instead of reporting a completion | 2067 | match the text at point, then instead of reporting a completion |
| 2068 | failure, the completion should try the next completion function. | 2068 | failure, the completion should try the next completion function. |
| 2069 | As is the case with most hooks, the functions are responsible to preserve | 2069 | As is the case with most hooks, the functions are responsible for |
| 2070 | things like point and current buffer.") | 2070 | preserving things like point and current buffer.") |
| 2071 | 2071 | ||
| 2072 | (defvar completion--capf-misbehave-funs nil | 2072 | (defvar completion--capf-misbehave-funs nil |
| 2073 | "List of functions found on `completion-at-point-functions' that misbehave. | 2073 | "List of functions found on `completion-at-point-functions' that misbehave. |