diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/minibuf.texi | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index 196dd990767..6324c2944c0 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi | |||
| @@ -1927,21 +1927,25 @@ completion behavior is overridden. @xref{Completion Variables}. | |||
| 1927 | @item annotation-function | 1927 | @item annotation-function |
| 1928 | The value should be a function for @dfn{annotating} completions. The | 1928 | The value should be a function for @dfn{annotating} completions. The |
| 1929 | function should take one argument, @var{string}, which is a possible | 1929 | function should take one argument, @var{string}, which is a possible |
| 1930 | completion. It should return a string, which is displayed after the | 1930 | completion. It may return a string, which is meant to be displayed |
| 1931 | completion @var{string} in the @file{*Completions*} buffer. | 1931 | along with @var{string} in the settings such as the |
| 1932 | Unless this function puts own face on the annotation suffix string, | 1932 | @file{*Completions*}. If the returned is propertized with strings for |
| 1933 | the @code{completions-annotations} face is added by default to | 1933 | the @code{prefix} or @code{suffix} text properties (@pxref{Text |
| 1934 | that string. | 1934 | Properties}), those properties function as more specific hints of how |
| 1935 | to display. Unless this function puts own face on the annotation | ||
| 1936 | strings, the @code{completions-annotations} face is added by default | ||
| 1937 | to them. | ||
| 1935 | 1938 | ||
| 1936 | @item affixation-function | 1939 | @item affixation-function |
| 1937 | The value should be a function for adding prefixes and suffixes to | 1940 | This function does exactly the same as @code{annotation-function} but |
| 1938 | completions. The function should take one argument, | 1941 | takes priority over it and uses a different protocol. The value |
| 1939 | @var{completions}, which is a list of possible completions. It should | 1942 | should be a function for adding prefixes and suffixes to completions. |
| 1940 | return such a list of @var{completions} where each element contains a list | 1943 | The function should take one argument, @var{completions}, which is a |
| 1941 | of three elements: a completion, a prefix which is displayed before | 1944 | list of possible completions. It should return such a list of |
| 1942 | the completion string in the @file{*Completions*} buffer, and | 1945 | @var{completions} where each element contains a list of three |
| 1943 | a suffix displayed after the completion string. This function | 1946 | elements: a completion, a prefix which is displayed before the |
| 1944 | takes priority over @code{annotation-function}. | 1947 | completion string in the @file{*Completions*} buffer, and a suffix |
| 1948 | displayed after the completion string. | ||
| 1945 | 1949 | ||
| 1946 | @item group-function | 1950 | @item group-function |
| 1947 | The value should be a function for grouping the completion candidates. | 1951 | The value should be a function for grouping the completion candidates. |