summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2020-11-07 11:10:36 +0200
committerEli Zaretskii <eliz@gnu.org>2020-11-07 11:10:36 +0200
commit9da0f4026c62ac917e84780a27a00eefc0f1c0c6 (patch)
tree7af87cb9929abea42af96387527e0145c2ca24a5
parent9899f74e4e1f45064a3235db153739ab769a3e45 (diff)
downloademacs-9da0f4026c62ac917e84780a27a00eefc0f1c0c6.tar.gz
* lisp/subr.el (read-char-from-minibuffer): Doc fix. (Bug#44451)
-rw-r--r--lisp/subr.el12
1 files changed, 7 insertions, 5 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 2b3231b879b..fcbd06a449f 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -2712,12 +2712,14 @@ Also discard all previous input in the minibuffer."
(defvar empty-history)
(defun read-char-from-minibuffer (prompt &optional chars history)
- "Read a character from the minibuffer, prompting for PROMPT.
+ "Read a character from the minibuffer, prompting for it with PROMPT.
Like `read-char', but uses the minibuffer to read and return a character.
-When CHARS is non-nil, any input that is not one of CHARS is ignored.
-When HISTORY is a symbol, then allows navigating in a history.
-The navigation commands are `M-p' and `M-n', with `RET' to select
-a character from history."
+Optional argument CHARS, if non-nil, should be a list of characters;
+the function will ignore any input that is not one of CHARS.
+Optional argument HISTORY, if non-nil, should be a symbol that
+specifies the history list variable to use for navigating in input
+history using `M-p' and `M-n', with `RET' to select a character from
+history."
(let* ((empty-history '())
(map (if (consp chars)
(or (gethash chars read-char-from-minibuffer-map-hash)