traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix up a few style nits -- avoid "e.g." and "i.e." -- these make 

translation more difficult, as well as reading the English more
difficult for non-native speakers.

Add an index entry for the Telnet protocol.

Always refer to the protocol as Telnet instead of telnet.
This commit is contained in:
Fred Drake 2001-07-06 20:23:02 +00:00
parent 40fb452be9
commit ab1df4fe88
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/lib/libtelnetlib.tex
View File

@ -5,13 +5,15 @@
\modulesynopsis{Telnet client class.} \modulesynopsis{Telnet client class.}
\sectionauthor{Skip Montanaro}{skip@mojam.com} \sectionauthor{Skip Montanaro}{skip@mojam.com}
\index{protocol!Telnet}
The \module{telnetlib} module provides a \class{Telnet} class that The \module{telnetlib} module provides a \class{Telnet} class that
implements the Telnet protocol. See \rfc{854} for details about the implements the Telnet protocol. See \rfc{854} for details about the
protocol. protocol.
\begin{classdesc}{Telnet}{\optional{host\optional{, port}}} \begin{classdesc}{Telnet}{\optional{host\optional{, port}}}
\class{Telnet} represents a connection to a telnet server. The \class{Telnet} represents a connection to a Telnet server. The
instance is initially not connected by default; the \method{open()} instance is initially not connected by default; the \method{open()}
method must be used to establish a connection. Alternatively, the method must be used to establish a connection. Alternatively, the
host name and optional port number can be passed to the constructor, host name and optional port number can be passed to the constructor,
@ -92,7 +94,7 @@ never blocks.
\begin{methoddesc}{open}{host\optional{, port}} \begin{methoddesc}{open}{host\optional{, port}}
Connect to a host. Connect to a host.
The optional second argument is the port number, which The optional second argument is the port number, which
defaults to the standard telnet port (23). defaults to the standard Telnet port (23).
Do not try to reopen an already connected instance. Do not try to reopen an already connected instance.
\end{methoddesc} \end{methoddesc}
@ -127,7 +129,7 @@ This can block if the connection is blocked. May raise
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{interact}{} \begin{methoddesc}{interact}{}
Interaction function, emulates a very dumb telnet client. Interaction function, emulates a very dumb Telnet client.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{mt_interact}{} \begin{methoddesc}{mt_interact}{}
@ -151,7 +153,7 @@ If end of file is found and no text was read, raise
\code{(-1, None, \var{text})} where \var{text} is the text received so \code{(-1, None, \var{text})} where \var{text} is the text received so
far (may be the empty string if a timeout happened). far (may be the empty string if a timeout happened).
If a regular expression ends with a greedy match (e.g. \regexp{.*}) If a regular expression ends with a greedy match (such as \regexp{.*})
or if more than one expression can match the same input, the or if more than one expression can match the same input, the
results are indeterministic, and may depend on the I/O timing. results are indeterministic, and may depend on the I/O timing.
\end{methoddesc} \end{methoddesc}