]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix documentation of 'completing-read' and friends
authorEli Zaretskii <eliz@gnu.org>
Fri, 10 Jun 2022 11:22:18 +0000 (14:22 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 10 Jun 2022 11:22:18 +0000 (14:22 +0300)
* src/minibuf.c (Fcompleting_read):
* lisp/minibuffer.el (read-file-name):
* doc/lispref/minibuf.texi (Minibuffer Completion):
* etc/NEWS: Fix typos and wording of the description of the
REQUIRE-MATCH argument to 'completing-read'.

doc/lispref/minibuf.texi
etc/NEWS
lisp/minibuffer.el
src/minibuf.c

index 86e601f8c0f086d214f7280144d60baa1864e9ba..1451e59d05c559c8008fe880c58846075c9ed417 100644 (file)
@@ -1122,9 +1122,9 @@ completion command (i.e., one of the commands in
 not an element of @var{collection}.  @xref{Completion Commands}.
 
 @item
-If a function, the function is called with the input as the only
-argument.  The function should return a non-@code{nil} value of the
-input is acceptable.
+If a function, it is called with the input as the only argument.  The
+function should return a non-@code{nil} value if the input is
+acceptable.
 
 @item
 Any other value of @var{require-match} behaves like @code{t}, except
index e19d08d51fce2e32e6b625eea1300afd1f8e5c53..88758abc64e856eb29f58f9b83c06a5449d6f1f8 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1952,7 +1952,7 @@ Previously it produced a nonsense value, -1, that was never intended.
 * Lisp Changes in Emacs 29.1
 
 +++
-** 'completing-read' now allows a function as REQUIRE-MATCH.
+** 'completing-read' now allows a function as its REQUIRE-MATCH argument.
 This function is called to see whether what the user has typed in is a
 match.  This is also available from functions that call
 'completing-read', like 'read-file-name'.
index 332e3fcce977dc2407a7e5143a699b8124e3751a..bf89874ecc8e3bfc47bbc5cc7bcb662315efea27 100644 (file)
@@ -3161,8 +3161,8 @@ Fourth arg MUSTMATCH can take the following values:
   input, but she needs to confirm her choice if she called
   `minibuffer-complete' right before `minibuffer-complete-and-exit'
   and the input is not an existing file.
-- a function, which will be called with the input as the parameter.
-  If it returns a non-nil value, we exit with that value.
+- a function, which will be called with the input as the argument.
+  If it returns a non-nil value, the minibuffer is exited with that value.
 - anything else behaves like t except that typing RET does not exit if it
   does non-null completion.
 
index 3e984d163d16a5c1769d78bae612b7d990f271af..2cfc2caa7f6582b3365362b7b76b72a86d790119 100644 (file)
@@ -2010,7 +2010,7 @@ REQUIRE-MATCH can take the following values:
   `minibuffer-complete' right before `minibuffer-complete-and-exit'
   and the input is not an element of COLLECTION.
 - a function, which will be called with the input as the parameter.
-  If it returns a non-nil value, we exit with that value.
+  If it returns a non-nil value, the minibuffer is exited with that value.
 - anything else behaves like t except that typing RET does not exit if it
   does non-null completion.