procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of read-multiple-choice

Browse source 
* doc/lispref/commands.texi (Reading One Event): Document optional
third argument help-string of read-multiple-choice.
This commit is contained in:
Stefan Kangas 2021-12-26 01:08:33 +01:00
parent 5fccd1e371
commit 89a82182cb
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/lispref/commands.texi
View 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