summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-03-20 18:21:44 +0200
committerEli Zaretskii <eliz@gnu.org>2022-03-20 18:21:44 +0200
commit9fcdd5b63fcb5f9c6fba9884911f305806980fd5 (patch)
treefce765b0f787e1e7e9e5cf431623ab9429f191f0
parente059d7c156edb37a7c836906b9a3510adee3d543 (diff)
downloademacs-9fcdd5b63fcb5f9c6fba9884911f305806980fd5.tar.gz
Improve doc strings of read-char-from-minibuffer-insert-* commands
* lisp/subr.el (read-char-from-minibuffer-insert-char) (read-char-from-minibuffer-insert-other): Clarify the doc strings. (Bug#54479)
-rw-r--r--lisp/subr.el10
1 files changed, 6 insertions, 4 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 8e5a65efcd2..921853de607 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -3050,7 +3050,7 @@ If there is a natural number at point, use it as default."
(make-hash-table :test 'equal))
(defun read-char-from-minibuffer-insert-char ()
- "Insert the character you type in the minibuffer and exit.
+ "Insert the character you type into the minibuffer and exit minibuffer.
Discard all previous input before inserting and exiting the minibuffer."
(interactive)
(when (minibufferp)
@@ -3059,9 +3059,11 @@ Discard all previous input before inserting and exiting the minibuffer."
(exit-minibuffer)))
(defun read-char-from-minibuffer-insert-other ()
- "Handle inserting of a character other than allowed.
-Display an error on trying to insert a disallowed character.
-Also discard all previous input in the minibuffer."
+ "Reject a disallowed character typed into the minibuffer.
+This command is intended to be bound to keys that users are not
+allowed to type into the minibuffer. When the user types any
+such key, this command discard all minibuffer input and displays
+an error message."
(interactive)
(when (minibufferp)
(delete-minibuffer-contents)