Document the changes in 'read-answer'

* doc/lispref/minibuf.texi (Multiple Queries): Document the
fact that 'read-answer' can now accept non-character input
events.
This commit is contained in:
Eli Zaretskii 2020-03-07 13:40:10 +02:00
parent 10c58356e4
commit fdbe7cacfb
2 changed files with 11 additions and 10 deletions

View file

@ -2227,16 +2227,16 @@ the end of @var{question}. The possible responses are provided in
@noindent @noindent
where @var{long-answer} is the complete text of the user response, a where @var{long-answer} is the complete text of the user response, a
string; @var{short-answer} is a short form of the same response, a string; @var{short-answer} is a short form of the same response, a
single character; and @var{help-message} is the text that describes single character or a function key; and @var{help-message} is the text
the meaning of the answer. If the variable @code{read-answer-short} that describes the meaning of the answer. If the variable
is non-@code{nil}, the prompt will show the short variants of the @code{read-answer-short} is non-@code{nil}, the prompt will show the
possible answers and the user is expected to type the single short variants of the possible answers and the user is expected to
characters shown in the prompt; otherwise the prompt will show the type the single characters/keys shown in the prompt; otherwise the
long variants of the answers, and the user is expected to type the prompt will show the long variants of the answers, and the user is
full text of one of the answers and end by pressing @key{RET}. If expected to type the full text of one of the answers and end by
@code{use-dialog-box} is non-@code{nil}, and this function was invoked pressing @key{RET}. If @code{use-dialog-box} is non-@code{nil}, and
by mouse events, the question and the answers will be displayed in a this function was invoked by mouse events, the question and the
GUI dialog box. answers will be displayed in a GUI dialog box.
The function returns the text of the @var{long-answer} selected by the The function returns the text of the @var{long-answer} selected by the
user, regardless of whether long or short answers were shown in the user, regardless of whether long or short answers were shown in the

View file

@ -347,6 +347,7 @@ The default value is 30000, as the previously hard-coded threshold.
+++ +++
** The function 'read-passwd' uses "*" as default character to hide passwords. ** The function 'read-passwd' uses "*" as default character to hide passwords.
+++
** The function 'read-answer' now accepts not only single character ** The function 'read-answer' now accepts not only single character
answers, but also function keys like 'F1', character events such as answers, but also function keys like 'F1', character events such as
'C-M-h', and control characters like 'C-h'. 'C-M-h', and control characters like 'C-h'.