From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 27 Jan 2007 18:01:15 +0000 (+0000)
Subject: (Fcompleting_read): Doc fix.
X-Git-Tag: emacs-pretest-22.0.94~604
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=4fda07c1a645b7d3bae345f767212d7d215fa21e;p=emacs.git

(Fcompleting_read): Doc fix.
---

diff --git a/src/ChangeLog b/src/ChangeLog
index c5f022e54e0..f0d1b80ad72 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,7 @@
+2007-01-27  Eli Zaretskii  <eliz@gnu.org>
+
+	* minibuf.c (Fcompleting_read): Doc fix.
+
 2007-01-26  Jan Dj,Ad(Brv  <jan.h.d@swipnet.se>
 
 	* gtkutil.c (xg_initialize): Call XftInit if HAVE_XFT.
diff --git a/src/minibuf.c b/src/minibuf.c
index 5618f0223a4..9c078a37b3d 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -1686,11 +1686,16 @@ Lisp_Object Vminibuffer_completing_file_name;
 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.