]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/subr.el (read-char-from-minibuffer): Doc fix. (Bug#44451)
authorEli Zaretskii <eliz@gnu.org>
Sat, 7 Nov 2020 09:10:36 +0000 (11:10 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 7 Nov 2020 09:10:36 +0000 (11:10 +0200)
lisp/subr.el

index 2b3231b879b0544067ca6af0c5896fff684712bd..fcbd06a449f51b5c781fd293635664e5f573100f 100644 (file)
@@ -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)