From: Eli Zaretskii <eliz@gnu.org>
Date: Sun, 20 Mar 2022 16:21:44 +0000 (+0200)
Subject: Improve doc strings of read-char-from-minibuffer-insert-* commands
X-Git-Tag: emacs-28.1~12
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=9fcdd5b63f;p=emacs.git

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)
---

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)