Mercurial > emacs
changeset 75431:6c4552697561
(Fcompleting_read): Doc fix.
| author | Eli Zaretskii <eliz@gnu.org> |
|---|---|
| date | Sat, 27 Jan 2007 18:00:28 +0000 |
| parents | 06172d4ae1d7 |
| children | b17465653dc8 |
| files | src/minibuf.c |
| diffstat | 1 files changed, 8 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/src/minibuf.c Sat Jan 27 17:38:14 2007 +0000 +++ b/src/minibuf.c Sat Jan 27 18:00:28 2007 +0000 @@ -1686,11 +1686,16 @@ DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0, doc: /* Read a string in the minibuffer, with completion. PROMPT is a string to prompt with; normally it ends in a colon and a space. -TABLE can be a list of strings, an alist, an obarray or a hash table. -TABLE can also be a function to do the completion itself. + +TABLE can be a list of strings, an alist, an obarray or a hash table; their +elements are tested to see if they begin with STRING. +TABLE can also be a function to do the completion itself; it receives +three arguments: the values STRING, PREDICATE and nil. +Whatever it returns becomes the value of `try-completion'. + PREDICATE limits completion to a subset of TABLE. See `try-completion' and `all-completions' for more details - on completion, TABLE, and PREDICATE. + on completion, TABLE (called "alist" there), and PREDICATE. If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless the input is (or completes to) an element of TABLE or is null.