summaryrefslogtreecommitdiffstats
path: root/Doc/lib/librlcompleter.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-07-06 04:51:04 (GMT)
committerFred Drake <fdrake@acm.org>2000-07-06 04:51:04 (GMT)
commit3c62d9e65651a505072df7a760e4876d45d4814a (patch)
tree220cddfe2462caff7354d9b2796cba0ee4dfb4d9 /Doc/lib/librlcompleter.tex
parent14ea85f325ad84400be86de02f60beebaa36cc53 (diff)
downloadcpython-3c62d9e65651a505072df7a760e4876d45d4814a.zip
cpython-3c62d9e65651a505072df7a760e4876d45d4814a.tar.gz
cpython-3c62d9e65651a505072df7a760e4876d45d4814a.tar.bz2
Several small changes, mostly to the markup, to improve consistency and
internal hyperlinking. Move some things around, also for consistency with other modules ("See also" stuff tends to live at the \section level, before sub-sections, etc.).
Diffstat (limited to 'Doc/lib/librlcompleter.tex')
-rw-r--r--Doc/lib/librlcompleter.tex10
1 files changed, 7 insertions, 3 deletions
diff --git a/Doc/lib/librlcompleter.tex b/Doc/lib/librlcompleter.tex
index 74b0c78..c0c4db8 100644
--- a/Doc/lib/librlcompleter.tex
+++ b/Doc/lib/librlcompleter.tex
@@ -2,12 +2,16 @@
Completion function for readline}
\declaremodule{standard}{rlcompleter}
+ \platform{Unix}
\sectionauthor{Moshe Zadka}{mzadka@geocities.com}
\modulesynopsis{Python identifier completion in the readline library.}
The \module{rlcompleter} module defines a completion function for
-the \module{readline} module by completing valid Python identifiers and
-keyword.
+the \refmodule{readline} module by completing valid Python identifiers
+and keywords.
+
+This module is \UNIX-specific due to it's dependence on the
+\refmodule{readline} module.
The \module{rlcompleter} module defines the \class{Completer} class.
@@ -47,7 +51,7 @@ Completer objects have the following method:
\begin{methoddesc}[Completer]{complete}{text, state}
Return the \var{state}th completion for \var{text}.
-If called for \var{text} that doesn't includea period character
+If called for \var{text} that doesn't include a period character
(\character{.}), it will complete from names currently defined in
\refmodule[main]{__main__}, \refmodule[builtin]{__builtin__} and
keywords (as defined by the \refmodule{keyword} module).