emacs-29 756244c6963: ; * lisp/minibuffer.el (completions-header-format): Doc fix.

[Eli Zaretskii]

branch: emacs-29
commit 756244c69638bc3562d8cd2c1aa126216e99fb29
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>

    ; * lisp/minibuffer.el (completions-header-format): Doc fix.
---
 lisp/minibuffer.el | 13 ++++++++-----
 1 file 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)