diff options
author | Eli Zaretskii <eliz@gnu.org> | 2018-04-01 12:19:49 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2018-04-01 12:19:49 +0300 |
commit | a8ddd05d7d32946b892b9faaba6c9736ed2ad847 (patch) | |
tree | 40a182e08bae811ba6180f50e193bfb0d44c0d9d /doc | |
parent | 320ecd3e564facaabdb6324f94c07c447f3175b9 (diff) | |
download | emacs-a8ddd05d7d32946b892b9faaba6c9736ed2ad847.tar.gz |
Minor copyedits of completion-at-point-functions documentation
* lisp/minibuffer.el (completion-at-point-functions):
* doc/lispref/minibuf.texi (Completion in Buffers): Fix wording
and filling.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/minibuf.texi | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index b01ebb26b69..1d1c93dd144 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi @@ -1877,10 +1877,11 @@ are used to compute a completion table for completing the text at point. It can be used by major modes to provide mode-specific completion tables (@pxref{Major Mode Conventions}). -When the command @code{completion-at-point} runs, it calls the functions in the -list one by one, without any argument. Each function should return @code{nil} -unless it can and wants to take responsibility for the completion data for the -text at point. Otherwise it should return a list of the form +When the command @code{completion-at-point} runs, it calls the +functions in the list one by one, without any argument. Each function +should return @code{nil} unless it can and wants to take +responsibility for the completion data for the text at point. +Otherwise it should return a list of the following form: @example (@var{start} @var{end} @var{collection} . @var{props}) @@ -1910,8 +1911,8 @@ next function in @code{completion-at-point-functions} instead of reporting a completion failure. @end table -The functions on this hook should generally return quickly, since they may be -called very often (e.g., from @code{post-command-hook}). +The functions on this hook should generally return quickly, since they +may be called very often (e.g., from @code{post-command-hook}). Supplying a function for @var{collection} is strongly recommended if generating the list of completions is an expensive operation. Emacs may internally call functions in @code{completion-at-point-functions} @@ -1934,10 +1935,11 @@ can defer generating completions until necessary. You can use (my-make-completions))))) @end smallexample -Additionally, the @var{collection} should generally not be pre-filtered based -on the current text between @var{start} and @var{end}, because that is the -responsibility of the caller of @code{completion-at-point-functions} to do that -according to the completion styles it decides to use. +Additionally, the @var{collection} should generally not be +pre-filtered based on the current text between @var{start} and +@var{end}, because that is the responsibility of the caller of +@code{completion-at-point-functions} to do that according to the +completion styles it decides to use. A function in @code{completion-at-point-functions} may also return a function instead of a list as described above. In that case, that |