]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of read-multiple-choice
authorStefan Kangas <stefan@marxist.se>
Sun, 26 Dec 2021 00:08:33 +0000 (01:08 +0100)
committerStefan Kangas <stefan@marxist.se>
Sun, 26 Dec 2021 00:09:31 +0000 (01:09 +0100)
* doc/lispref/commands.texi (Reading One Event): Document optional
third argument help-string of read-multiple-choice.

doc/lispref/commands.texi

index 35ef61700c257d295e7169e7e88bafc2b1453f92..4e36d5807c1b656b32f37bb181a657f7c1ef7b12 100644 (file)
@@ -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}.
 
 @lisp