]> granicus.if.org Git - python/commitdiff
Cleaned up the description of readline.set_completer().
authorFred Drake <fdrake@acm.org>
Wed, 1 Aug 2001 21:42:45 +0000 (21:42 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 1 Aug 2001 21:42:45 +0000 (21:42 +0000)
Thanks to Nathaniel Gray for reporting the confusion.

Doc/lib/libreadline.tex

index 9d0091ab3f9e79a95cbf6309f38a38b7f3788e5f..a35714449df29bab399bf2c11d12fdfb408904b2 100644 (file)
@@ -55,10 +55,13 @@ file size.
 \end{funcdesc}
 
 \begin{funcdesc}{set_completer}{\optional{function}}
-Set or remove the completer function.  The completer function is
-called as \code{\var{function}(\var{text}, \var{state})},
-\code{for i in [0, 1, 2, ...]} until it returns a non-string.
-It should return the next possible completion starting with \var{text}.
+Set or remove the completer function.  If \var{function} is specified,
+it will be used as the new completer function; if omitted or
+\code{None}, any completer function already installed is removed.  The
+completer function is called as \code{\var{function}(\var{text},
+\var{state})}, for \var{state} in \code{0}, \code{1}, \code{2}, ...,
+until it returns a non-string value.  It should return the next
+possible completion starting with \var{text}.
 \end{funcdesc}
 
 \begin{funcdesc}{get_begidx}{}