summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-08-01 21:42:45 (GMT)
committerFred Drake <fdrake@acm.org>2001-08-01 21:42:45 (GMT)
commit905dc558f184cfb706d39a582d1abcfef3d37962 (patch)
treee9198913ab3511a40577dc52b4cbf186e72b2f1e /Doc/lib
parent722d78f18ace538417b749412cd47545cbc61b3f (diff)
downloadcpython-905dc558f184cfb706d39a582d1abcfef3d37962.zip
cpython-905dc558f184cfb706d39a582d1abcfef3d37962.tar.gz
cpython-905dc558f184cfb706d39a582d1abcfef3d37962.tar.bz2
Cleaned up the description of readline.set_completer().
Thanks to Nathaniel Gray for reporting the confusion.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libreadline.tex11
1 files changed, 7 insertions, 4 deletions
diff --git a/Doc/lib/libreadline.tex b/Doc/lib/libreadline.tex
index 9d0091a..a357144 100644
--- a/Doc/lib/libreadline.tex
+++ b/Doc/lib/libreadline.tex
@@ -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}{}