Clarify test-completion doc string

* src/minibuf.c (Ftest_completion): Clarify what it means to be a
valid completion (bug#50583).
This commit is contained in:
Lars Ingebrigtsen 2021-09-16 14:18:30 +02:00
parent 373c644fcc
commit db12b38653

View file

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