diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2023-05-27 20:20:33 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2023-05-27 20:20:33 +0300 |
| commit | 756244c69638bc3562d8cd2c1aa126216e99fb29 (patch) | |
| tree | e5edfe3aacf73f019ea045da782f118ff5d4de9b /lisp/minibuffer.el | |
| parent | 5d844e129ad5b42b74c363cde50aedc08a96cf39 (diff) | |
| download | emacs-756244c69638bc3562d8cd2c1aa126216e99fb29.tar.gz emacs-756244c69638bc3562d8cd2c1aa126216e99fb29.tar.bz2 emacs-756244c69638bc3562d8cd2c1aa126216e99fb29.zip | |
; * lisp/minibuffer.el (completions-header-format): Doc fix.
Diffstat (limited to 'lisp/minibuffer.el')
| -rw-r--r-- | lisp/minibuffer.el | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 747c9443afa..298f3f8728d 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el @@ -2025,11 +2025,14 @@ completions." (defcustom completions-header-format (propertize "%s possible completions:\n" 'face 'shadow) - "Format of completions header. -It may contain one %s to show the total count of completions. -When nil, no header is shown." - :type '(choice (const :tag "No header" nil) - (string :tag "Header format string")) + "If non-nil, the format string for completions heading line. +The heading line is inserted before the completions, and is intended +to summarize the completions. +The format string may include one %s, which will be replaced with +the total count of possible completions. +If this is nil, no heading line will be shown." + :type '(choice (const :tag "No heading line" nil) + (string :tag "Format string for heading line")) :version "29.1") (defun completion--insert-strings (strings &optional group-fun) |