From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Thu, 16 Sep 2021 12:18:30 +0000 (+0200)
Subject: Clarify test-completion doc string
X-Git-Tag: archive/raspbian/1%29.2+1-2+rpi1^2~5^2~18^2~1183
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=db12b386537f0a0d36a4759c625ba643e391e4f2;p=emacs.git

Clarify test-completion doc string

* src/minibuf.c (Ftest_completion): Clarify what it means to be a
valid completion (bug#50583).
---

diff --git a/src/minibuf.c b/src/minibuf.c
index c9134eff67f..a0ba86763f4 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -2055,7 +2055,11 @@ See also `completing-read-function'.  */)
 /* Test whether TXT is an exact completion.  */
 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
        doc: /* Return non-nil if STRING is a valid completion.
+For instance, if COLLECTION is a list of strings, this is true if
+STRING appears in the list and PREDICATE is satisfied.
+
 Takes the same arguments as `all-completions' and `try-completion'.
+
 If COLLECTION is a function, it is called with three arguments:
 the values STRING, PREDICATE and `lambda'.  */)
   (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)