]> granicus.if.org Git - python/commitdiff
Fixed a large number of small problems, mostly noted by Detlef Lannert
authorFred Drake <fdrake@acm.org>
Tue, 10 Oct 2000 22:00:03 +0000 (22:00 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 10 Oct 2000 22:00:03 +0000 (22:00 +0000)
<lannert@lannert.rz.uni-duesseldorf.de>.

Doc/lib/libdis.tex
Doc/lib/libimp.tex
Doc/lib/libmailbox.tex
Doc/lib/libmimetools.tex
Doc/lib/libnew.tex
Doc/lib/libre.tex
Doc/lib/libsite.tex
Doc/lib/libuserdict.tex
Doc/lib/libxmllib.tex

index 2dd74bdb6200026c86bd3953b715a498ec6eb8bf..7fc831aaa07c3215ce0f940f1df13dd138bf8ddf 100644 (file)
@@ -2,8 +2,7 @@
          Disassembler for Python byte code}
 
 \declaremodule{standard}{dis}
-\modulesynopsis{Disassembler for Python byte code, as stored in code
-                objects and \file{.pyc}/\file{.pyo} files.}
+\modulesynopsis{Disassembler for Python byte code.}
 
 
 The \module{dis} module supports the analysis of Python byte code by
@@ -35,7 +34,7 @@ the following command can be used to get the disassembly of
          19 RETURN_VALUE   
 \end{verbatim}
 
-The \module{dis} module defines the following functions:
+The \module{dis} module defines the following functions and constants:
 
 \begin{funcdesc}{dis}{\optional{bytesource}}
 Disassemble the \var{bytesource} object. \var{bytesource} can denote
@@ -75,7 +74,7 @@ for compatibility with earlier Python releases.
 \end{funcdesc}
 
 \begin{datadesc}{opname}
-Sequence of operation names, indexable using the byte code.
+Sequence of operation names, indexable using the byte code.
 \end{datadesc}
 
 \begin{datadesc}{cmp_op}
@@ -87,7 +86,7 @@ Sequence of byte codes that have a constant parameter.
 \end{datadesc}
 
 \begin{datadesc}{hasname}
-Sequence of byte codes that access a attribute by name.
+Sequence of byte codes that access an attribute by name.
 \end{datadesc}
 
 \begin{datadesc}{hasjrel}
@@ -99,7 +98,7 @@ Sequence of byte codes that have an absolute jump target.
 \end{datadesc}
 
 \begin{datadesc}{haslocal}
-Sequence of byte codes that access a local variable.
+Sequence of byte codes that access a local variable.
 \end{datadesc}
 
 \begin{datadesc}{hascompare}
@@ -196,11 +195,11 @@ Implements \code{TOS = TOS1[TOS]}.
 \end{opcodedesc}
 
 \begin{opcodedesc}{BINARY_LSHIFT}{}
-Implements \code{TOS = TOS1 << TOS}.
+Implements \code{TOS = TOS1 <\code{}< TOS}.
 \end{opcodedesc}
 
 \begin{opcodedesc}{BINARY_RSHIFT}{}
-Implements \code{TOS = TOS1 >> TOS}.
+Implements \code{TOS = TOS1 >\code{}> TOS}.
 \end{opcodedesc}
 
 \begin{opcodedesc}{BINARY_AND}{}
@@ -245,11 +244,11 @@ Implements in-place \code{TOS = TOS1 - TOS}.
 \end{opcodedesc}
 
 \begin{opcodedesc}{INPLACE_LSHIFT}{}
-Implements in-place \code{TOS = TOS1 << TOS}.
+Implements in-place \code{TOS = TOS1 <\code{}< TOS}.
 \end{opcodedesc}
 
 \begin{opcodedesc}{INPLACE_RSHIFT}{}
-Implements in-place \code{TOS = TOS1 >> TOS}.
+Implements in-place \code{TOS = TOS1 >\code{}> TOS}.
 \end{opcodedesc}
 
 \begin{opcodedesc}{INPLACE_AND}{}
index 4c66736bd1e3bdce3dd9928dc35d00be3a5a6ac9..10b6253ad31e020851e2e2952fabf7aabcae1c94 100644 (file)
@@ -70,14 +70,14 @@ Load a module that was previously found by \function{find_module()} (or by
 an otherwise conducted search yielding compatible results).  This
 function does more than importing the module: if the module was
 already imported, it is equivalent to a
-\function{reload()}\bifuncindex{reload}!  The
-\var{name} argument indicates the full module name (including the
-package name, if this is a submodule of a package).  The \var{file}
-argument is an open file, and \var{filename} is the corresponding
-file name; these can be \code{None} and \code{''}, respectively, when
-the module is not being loaded from a file.  The \var{description}
-argument is a tuple as returned by \function{find_module()} describing
-what kind of module must be loaded.
+\function{reload()}\bifuncindex{reload}!  The \var{name} argument
+indicates the full module name (including the package name, if this is
+a submodule of a package).  The \var{file} argument is an open file,
+and \var{filename} is the corresponding file name; these can be
+\code{None} and \code{''}, respectively, when the module is not being
+loaded from a file.  The \var{description} argument is a tuple, as
+would be returned by \function{get_suffixes()}, describing what kind
+of module must be loaded.
 
 If the load is successful, the return value is the module object;
 otherwise, an exception (usually \exception{ImportError}) is raised.
index 8beab4cd6fe7358b799a04db007c174c1a4212c8..082c061d6073773f4b3f2314f4d166cc2910bb47 100644 (file)
@@ -49,5 +49,6 @@ object (see the \refmodule{rfc822} module).  Depending on the mailbox
 implementation the \var{fp} attribute of this object may be a true
 file object or a class instance simulating a file object, taking care
 of things like message boundaries if multiple mail messages are
-contained in a single file, etc.
+contained in a single file, etc.  If no more messages are available,
+this method returns \code{None}.
 \end{methoddesc}
index fdf292cd3316f508e2881f2e38954cf874942292..f0e8e4ad191c725878631e01b535370ddfb50ddd 100644 (file)
@@ -61,15 +61,15 @@ open file \var{output}.  The block size is currently fixed at 8192.
 \end{seealso}
 
 
-\subsection{Additional Methods of Message objects}
-\nodename{mimetools.Message Methods}
+\subsection{Additional Methods of Message Objects
+            \label{mimetools-message-objects}}
 
 The \class{Message} class defines the following methods in
 addition to the \class{rfc822.Message} methods:
 
 \begin{methoddesc}{getplist}{}
 Return the parameter list of the \code{content-type} header.  This is
-a list if strings.  For parameters of the form
+a list of strings.  For parameters of the form
 \samp{\var{key}=\var{value}}, \var{key} is converted to lower case but
 \var{value} is not.  For example, if the message contains the header
 \samp{Content-type: text/html; spam=1; Spam=2; Spam} then
index df7adfbd26f868642677ded86ed85550abeab8fb..e96415c79a2448f466c368ab0882172aa13df93d 100644 (file)
@@ -27,12 +27,12 @@ callable, and \var{instance} must be an instance object or
 \code{None}.
 \end{funcdesc}
 
-\begin{funcdesc}{function}{code, globals\optional{, name\optional{argdefs}}}
+\begin{funcdesc}{function}{code, globals\optional{, name\optional{argdefs}}}
 Returns a (Python) function with the given code and globals. If
 \var{name} is given, it must be a string or \code{None}.  If it is a
 string, the function will have the given name, otherwise the function
 name will be taken from \code{\var{code}.co_name}.  If
-\var{argdefs} is given, it must be a tuple and will be used to the
+\var{argdefs} is given, it must be a tuple and will be used to
 determine the default values of parameters.
 \end{funcdesc}
 
index 37b4ee816e51cdb14d48fd0cb640dbb34a03e691..9e027e72ce06ca6ab77136fa015322b64fcef4a0 100644 (file)
@@ -180,7 +180,7 @@ parentheses, and indicates the start and end of a group; the contents
 of a group can be retrieved after a match has been performed, and can
 be matched later in the string with the \regexp{\e \var{number}} special
 sequence, described below.  To match the literals \character{(} or
-\character{')}, use \regexp{\e(} or \regexp{\e)}, or enclose them
+\character{)}, use \regexp{\e(} or \regexp{\e)}, or enclose them
 inside a character class: \regexp{[(] [)]}.
 
 \item[\code{(?...)}] This is an extension notation (a \character{?}
index b895a7355fb344aca08aeaeb26e853c8f506648c..b370db66577d575044cca914fe008cb30d15f72d 100644 (file)
@@ -22,7 +22,7 @@ the tail part, it uses the empty string (on Macintosh or Windows) or
 it uses first \file{lib/python\shortversion/site-packages} and then
 \file{lib/site-python} (on \UNIX{}).  For each of the distinct
 head-tail combinations, it sees if it refers to an existing directory,
-and if so, adds to \code{sys.path}, and also inspected for path
+and if so, adds to \code{sys.path}, and also inspects the path for
 configuration files.
 \indexii{site-python}{directory}
 \indexii{site-packages}{directory}
index 50d52fa6e28fac6bc7c310bb2d720f9d0dc7d5e9..0285380af957b146ed801a2fff60d1793e7362d4 100644 (file)
@@ -13,7 +13,7 @@ can add new behaviors to dictionaries.
 The \module{UserDict} module defines the \class{UserDict} class:
 
 \begin{classdesc}{UserDict}{\optional{initialdata}}
-Return a class instance that simulates a dictionary.  The instance's
+Class that simulates a dictionary.  The instance's
 contents are kept in a regular dictionary, which is accessible via the
 \member{data} attribute of \class{UserDict} instances.  If
 \var{initialdata} is provided, \member{data} is initialized with its
@@ -47,7 +47,7 @@ can add new behaviors to lists.
 The \module{UserList} module defines the \class{UserList} class:
 
 \begin{classdesc}{UserList}{\optional{list}}
-Return a class instance that simulates a list.  The instance's
+Class that simulates a list.  The instance's
 contents are kept in a regular list, which is accessible via the
 \member{data} attribute of \class{UserList} instances.  The instance's
 contents are initially set to a copy of \var{list}, defaulting to the
@@ -104,7 +104,7 @@ to real string or Unicode objects; this is especially the case for
 The \module{UserString} module defines the following classes:
 
 \begin{classdesc}{UserString}{\optional{sequence}}
-Return a class instance that simulates a string or a Unicode string
+Class that simulates a string or a Unicode string
 object.  The instance's content is kept in a regular string or Unicode
 string object, which is accessible via the \member{data} attribute of
 \class{UserString} instances.  The instance's contents are initially
index f60cecfd36cb474b4497831665f3c465ea723c91..e80201badd59780fa76a4ec959dd35896b4c4683 100644 (file)
@@ -274,7 +274,7 @@ the tag name was \code{'http://www.w3.org/TR/REC-html40 html'}, and
 the tag \code{<html:a href='http://frob.com'>} inside the above
 mentioned element is treated as if the tag name were
 \code{'http://www.w3.org/TR/REC-html40 a'} and the attribute name as
-if it were \code{'http://www.w3.org/TR/REC-html40 src'}.
+if it were \code{'http://www.w3.org/TR/REC-html40 href'}.
 
 An older draft of the XML Namespaces proposal is also recognized, but
 triggers a warning.