mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

; * doc/lispref/commands.texi (Reading One Event): Fix wording.

Browse source
This commit is contained in:
Eli Zaretskii 2025-11-02 07:41:08 +02:00
parent 2777178dc6
commit 0c6aee3021
1 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/lispref/commands.texi
View file

@ -3668,15 +3668,18 @@ character, or for keyboard-quit.
@end defun @end defun
@defun read-multiple-choice prompt choices &optional help-string show-help long-form @defun read-multiple-choice prompt choices &optional help-string show-help long-form
Ask user a multiple choice question. @var{prompt} should be a string Ask user a multiple-choice question and return user's choice.
that will be displayed as the prompt. @var{prompt} should be a string to display as the prompt.
@var{choices} is an alist where the first element in each entry is a @var{choices} is an alist where the first element in each entry is a
character to be entered, the second element is a short name for the character the user can type, the second element is a short name for the
entry to be displayed while prompting (if there's room, it might be entry to be displayed while prompting (if there's room, it might be
shortened), and the third, optional entry is a longer explanation that shortened), and the third, optional entry is a longer explanation that
will be displayed in a help buffer if the user requests more help. will be displayed in a help buffer if the user requests more help.
The return value is the entry from @var{choices} that matches the
character the user types.
If optional argument @var{help-string} is non-@code{nil}, it should be 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 a string with a more detailed description of all choices. It will be
displayed in a help buffer instead of the default auto-generated displayed in a help buffer instead of the default auto-generated
@ -3691,10 +3694,10 @@ will have to type in long-form answers (using @code{completing-read})
instead of hitting a single key. The answers must be among the second instead of hitting a single key. The answers must be among the second
elements of the values in the @var{choices} list. elements of the values in the @var{choices} list.
If the variable @code{read-char-choice-use-read-key} is non-@code{nil}, By default, this function uses @code{read-from-minibuffer} (@pxref{Text
this function uses @code{read-key} instead of @code{read-from-minibuffer}. from Minibuffer}) to read user input, but if the variable
@code{read-char-choice-use-read-key} is non-@code{nil}, it uses
The return value is the matching value from @var{choices}. @code{read-key} instead.
@lisp @lisp
(read-multiple-choice (read-multiple-choice