Added module references; minor grammatical fixes.

All suggested by Eric Raymond.
This commit is contained in:
Fred Drake 1999-05-11 15:14:15 +00:00
parent 9ade7e0110
commit 184e8360e8
3 changed files with 20 additions and 4 deletions

View file

@ -39,7 +39,7 @@ Return a new instance of the \class{ConfigParser} class. When
\var{defaults} is given, it is initialized into the dictionairy of \var{defaults} is given, it is initialized into the dictionairy of
intrinsic defaults. They keys must be strings, and the values must be intrinsic defaults. They keys must be strings, and the values must be
appropriate for the \samp{\%()s} string interpolation. Note that appropriate for the \samp{\%()s} string interpolation. Note that
\var{__name__} is always an intrinsic default; it's value is the \var{__name__} is always an intrinsic default; its value is the
section name. section name.
\end{classdesc} \end{classdesc}
@ -70,6 +70,12 @@ Exception raised when errors occur attempting to parse a file.
\end{excdesc} \end{excdesc}
\begin{seealso}
\seemodule{shlex}{Support for a creating \UNIX{} shell-like
minilanguages which can be used as an alternate format
for application configuration files.}
\end{seealso}
\subsection{ConfigParser Objects \label{ConfigParser-objects}} \subsection{ConfigParser Objects \label{ConfigParser-objects}}
\class{ConfigParser} instances have the following methods: \class{ConfigParser} instances have the following methods:

View file

@ -70,6 +70,10 @@ not begin with a digit in the range 1--5.
\begin{seealso} \begin{seealso}
\seemodule{netrc}{Parser for the \file{.netrc} file format. The file
\file{.netrc} is typically used by FTP clients to
load user authentication information before prompting
the user.}
\seetext{The file \file{Tools/scripts/ftpmirror.py}\index{ftpmirror.py} \seetext{The file \file{Tools/scripts/ftpmirror.py}\index{ftpmirror.py}
in the Python source distribution is a script that can mirror in the Python source distribution is a script that can mirror
FTP sites, or portions thereof, using the \module{ftplib} module. FTP sites, or portions thereof, using the \module{ftplib} module.

View file

@ -1,7 +1,7 @@
% Module and documentation by Eric S. Raymond, 21 Dec 1998 % Module and documentation by Eric S. Raymond, 21 Dec 1998
\section{\module{shlex} --- \section{\module{shlex} ---
Simple lexical analysis.} Simple lexical analysis}
\declaremodule{standard}{shlex} \declaremodule{standard}{shlex}
\modulesynopsis{Simple lexical analysis for \UNIX{} shell-like languages.} \modulesynopsis{Simple lexical analysis for \UNIX{} shell-like languages.}
@ -21,9 +21,15 @@ object. The initialization argument, if present, specifies where to
read characters from. It must be a file- or stream-like object with read characters from. It must be a file- or stream-like object with
\method{read()} and \method{readline()} methods. If no argument is given, \method{read()} and \method{readline()} methods. If no argument is given,
input will be taken from \code{sys.stdin}. input will be taken from \code{sys.stdin}.
\end{classdesc} \end{classdesc}
\begin{seealso}
\seemodule{ConfigParser}{Parser for configuration files similar to the
Windows \file{.ini} files.}
\end{seealso}
\subsection{shlex Objects \label{shlex-objects}} \subsection{shlex Objects \label{shlex-objects}}
A \class{shlex} instance has the following methods: A \class{shlex} instance has the following methods:
@ -64,7 +70,7 @@ carriage-return.
\begin{memberdesc}{quotes} \begin{memberdesc}{quotes}
Characters that will be considered string quotes. The token Characters that will be considered string quotes. The token
accumulates until the same quote is encountered again (thus, different accumulates until the same quote is encountered again (thus, different
quote types protect each other as in the shall.) By default, includes quote types protect each other as in the shell.) By default, includes
\ASCII{} single and double quotes. \ASCII{} single and double quotes.
\end{memberdesc} \end{memberdesc}