]> git.eshelyaron.com Git - emacs.git/commitdiff
Document the changes in 'read-answer'
authorEli Zaretskii <eliz@gnu.org>
Sat, 7 Mar 2020 11:40:10 +0000 (13:40 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 7 Mar 2020 11:40:10 +0000 (13:40 +0200)
* doc/lispref/minibuf.texi (Multiple Queries): Document the
fact that 'read-answer' can now accept non-character input
events.

doc/lispref/minibuf.texi
etc/NEWS

index 1266cf8ef653fc2e89e4840241de83b6fc0e6f61..c1615993f5e922e713c84b104611804564a0472c 100644 (file)
@@ -2227,16 +2227,16 @@ the end of @var{question}.  The possible responses are provided in
 @noindent
 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
-single character; and @var{help-message} is the text that describes
-the meaning of the answer.  If the variable @code{read-answer-short}
-is non-@code{nil}, the prompt will show the short variants of the
-possible answers and the user is expected to type the single
-characters shown in the prompt; otherwise the prompt will show the
-long variants of the answers, and the user is expected to type the
-full text of one of the answers and end by pressing @key{RET}.  If
-@code{use-dialog-box} is non-@code{nil}, and this function was invoked
-by mouse events, the question and the answers will be displayed in a
-GUI dialog box.
+single character or a function key; and @var{help-message} is the text
+that describes the meaning of the answer.  If the variable
+@code{read-answer-short} is non-@code{nil}, the prompt will show the
+short variants of the possible answers and the user is expected to
+type the single characters/keys shown in the prompt; otherwise the
+prompt will show the long variants of the answers, and the user is
+expected to type the full text of one of the answers and end by
+pressing @key{RET}.  If @code{use-dialog-box} is non-@code{nil}, and
+this function was invoked by mouse events, the question and the
+answers will be displayed in a GUI dialog box.
 
 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
index 2d719fb7a5b76f96eaacbc1a72770e3c52cabef7..08bd2af1595bbb8eddd116bab631f5617d7ae359 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -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-answer' now accepts not only single character
 answers, but also function keys like 'F1', character events such as
 'C-M-h', and control characters like 'C-h'.