* lisp/subr.el (read-char-from-minibuffer): Doc fix. (Bug#44451)

This commit is contained in:
Eli Zaretskii 2020-11-07 11:10:36 +02:00
parent 9899f74e4e
commit 9da0f4026c

View file

@ -2712,12 +2712,14 @@ Also discard all previous input in the minibuffer."
(defvar empty-history) (defvar empty-history)
(defun read-char-from-minibuffer (prompt &optional chars 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. 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. Optional argument CHARS, if non-nil, should be a list of characters;
When HISTORY is a symbol, then allows navigating in a history. the function will ignore any input that is not one of CHARS.
The navigation commands are `M-p' and `M-n', with `RET' to select Optional argument HISTORY, if non-nil, should be a symbol that
a character from history." 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 '()) (let* ((empty-history '())
(map (if (consp chars) (map (if (consp chars)
(or (gethash chars read-char-from-minibuffer-map-hash) (or (gethash chars read-char-from-minibuffer-map-hash)