[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

emacs-28 89a82182cb: Improve documentation of read-multiple-choice

From: Stefan Kangas
Subject: emacs-28 89a82182cb: Improve documentation of read-multiple-choice
Date: Sat, 25 Dec 2021 19:10:31 -0500 (EST)

branch: emacs-28
commit 89a82182cbca0caa19f5b9463629918b7131ef0c
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>

    Improve documentation of read-multiple-choice
    * doc/lispref/commands.texi (Reading One Event): Document optional
    third argument help-string of read-multiple-choice.
 doc/lispref/commands.texi | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 35ef61700c..4e36d5807c 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -2854,7 +2854,7 @@ causes it to evaluate @code{help-form} and display the 
result.  It
 then continues to wait for a valid input character, or keyboard-quit.
 @end defun
-@defun read-multiple-choice prompt choices
+@defun read-multiple-choice prompt choices &optional help-string
 Ask user a multiple choice question.  @var{prompt} should be a string
 that will be displayed as the prompt.
@@ -2864,6 +2864,11 @@ entry to be displayed while prompting (if there's room, 
it might be
 shortened), and the third, optional entry is a longer explanation that
 will be displayed in a help buffer if the user requests more help.
+If optional argument @var{help-string} is non-@code{nil}, it should be
+a string with a more detailed description of all choices.  It will be
+displayed in a help buffer instead of the default auto-generated
+description when the user types @kbd{?}.
 The return value is the matching value from @var{choices}.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]