; Improve documentation of 'eager-update'

* lisp/minibuffer.el (completion-metadata, completion-category-defaults)
(completion-category-overrides): Mention 'eager-update', alongside
'eager-display', in the docstring.   (Bug#79898)
This commit is contained in:
Kristoffer Balintona 2025-11-25 23:01:35 -06:00 committed by Eli Zaretskii
parent 368c86bab4
commit 3d21eaa3fc

View file

@ -142,6 +142,8 @@ This metadata is an alist. Currently understood keys are:
Works like `display-sort-function'.
- `eager-display': non-nil to request eager display of the
completion candidates.
- `eager-update': non-nil to request updating the display of completion
candidates as the user types.
The metadata of a completion table should be constant between two boundaries."
(let ((metadata (if (functionp table)
(funcall table string pred 'metadata))))
@ -1278,6 +1280,7 @@ an association list that can specify properties such as:
- `annotation-function': function to add annotations in *Completions*.
- `affixation-function': function to prepend/append a prefix/suffix.
- `eager-display': non-nil to show *Completions* eagerly.
- `eager-update': non-nil to update *Completions* eagerly.
Categories are symbols such as `buffer' and `file', used when
completing buffer and file names, respectively.
@ -1300,6 +1303,7 @@ possible values are the same as in `completions-sort'.
- `annotation-function': function to add annotations in *Completions*.
- `affixation-function': function to prepend/append a prefix/suffix.
- `eager-display': non-nil to show *Completions* eagerly.
- `eager-update': non-nil to update *Completions* as the user types.
See more description of metadata in `completion-metadata'.
Categories are symbols such as `buffer' and `file', used when