[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 75875ca: Fix recent documentation changes
From: |
Eli Zaretskii |
Subject: |
master 75875ca: Fix recent documentation changes |
Date: |
Thu, 14 Nov 2019 05:26:10 -0500 (EST) |
branch: master
commit 75875cac2100544f7c1192fc37ea23fbe9db12d7
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>
Fix recent documentation changes
* doc/lispref/minibuf.texi (Multiple Queries): Move the
reference to 'read-char-from-minibuffer' from here...
* doc/lispref/commands.texi (Reading One Event): ...to here.
Fix the wording of the description of
'read-char-from-minibuffer'.
---
doc/lispref/commands.texi | 3 +++
doc/lispref/minibuf.texi | 8 ++------
2 files changed, 5 insertions(+), 6 deletions(-)
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 0db38b7..0c848a8 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -2501,6 +2501,9 @@ and key sequences read from keyboard macros being
executed.
The lowest level functions for command input are @code{read-event},
@code{read-char}, and @code{read-char-exclusive}.
+If you need a function to read a character using the minibuffer, use
+@code{read-char-from-minibuffer} (@pxref{Multiple Queries}).
+
@defun read-event &optional prompt inherit-input-method seconds
This function reads and returns the next event of command input,
waiting if necessary until an event is available.
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index c87723d..4a218fe 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -2253,16 +2253,12 @@ Here is an example of using this function:
@end lisp
@end defun
-If you need a function to read a character like @code{read-char} or
-@code{read-char-choice} (@pxref{Reading One Event}) but using the
-minibuffer, use @code{read-char-from-minibuffer}.
-
@defun read-char-from-minibuffer prompt &optional chars history
This function uses the minibuffer to read and return a single
character. Optionally, it ignores any input that is not a member of
@var{chars}, a list of accepted characters. The @var{history}
-argument specifies the history list symbol to use; if is omitted or
-@code{nil}, it doesn't use the history.
+argument specifies the history list symbol to use; if it is omitted or
+@code{nil}, this function doesn't use the history.
@end defun
@node Reading a Password
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 75875ca: Fix recent documentation changes,
Eli Zaretskii <=