Skip to content

Commit

Permalink
Update doc to reflect Tim's changes to bool.
Browse files Browse the repository at this point in the history
  • Loading branch information
nnorwitz committed Apr 5, 2002
1 parent c334df5 commit d3dab2b
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 27 deletions.
4 changes: 2 additions & 2 deletions Doc/lib/libasyncore.tex
Original file line number Diff line number Diff line change
Expand Up @@ -118,14 +118,14 @@ \section{\module{asyncore} ---
\begin{methoddesc}{readable}{}
Each time through the \method{select()} loop, the set of sockets
is scanned, and this method is called to see if there is any
interest in reading. The default method simply returns \code{1},
interest in reading. The default method simply returns \code{True},
indicating that by default, all channels will be interested.
\end{methoddesc}

\begin{methoddesc}{writable}{}
Each time through the \method{select()} loop, the set of sockets
is scanned, and this method is called to see if there is any
interest in writing. The default method simply returns \code{1},
interest in writing. The default method simply returns \code{True},
indicating that by default, all channels will be interested.
\end{methoddesc}

Expand Down
3 changes: 2 additions & 1 deletion Doc/lib/libcfgparser.tex
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,8 @@ \subsection{ConfigParser Objects \label{ConfigParser-objects}}

\begin{methoddesc}{remove_section}{section}
Remove the specified \var{section} from the configuration.
If the section in fact existed, return 1. Otherwise return 0.
If the section in fact existed, return \code{True}.
Otherwise return \code{False}.
\end{methoddesc}

\begin{methoddesc}{optionxform}{option}
Expand Down
10 changes: 5 additions & 5 deletions Doc/lib/libcode.tex
Original file line number Diff line number Diff line change
Expand Up @@ -80,18 +80,18 @@ \subsection{Interactive Interpreter Objects
exception (\exception{SyntaxError} or \exception{OverflowError}). A
syntax traceback will be printed by calling the
\method{showsyntaxerror()} method. \method{runsource()} returns
\code{0}.
\code{False}.

\item
The input is incomplete, and more input is required;
\function{compile_command()} returned \code{None}.
\method{runsource()} returns \code{1}.
\method{runsource()} returns \code{True}.

\item
The input is complete; \function{compile_command()} returned a code
object. The code is executed by calling the \method{runcode()} (which
also handles run-time exceptions, except for \exception{SystemExit}).
\method{runsource()} returns \code{0}.
\method{runsource()} returns \code{False}.
\end{itemize}

The return value can be used to decide whether to use
Expand Down Expand Up @@ -155,8 +155,8 @@ \subsection{Interactive Console Objects
of the buffer as source. If this indicates that the command was
executed or invalid, the buffer is reset; otherwise, the command is
incomplete, and the buffer is left as it was after the line was
appended. The return value is \code{1} if more input is required,
\code{0} if the line was dealt with in some way (this is the same as
appended. The return value is \code{True} if more input is required,
\code{False} if the line was dealt with in some way (this is the same as
\method{runsource()}).
\end{methoddesc}

Expand Down
8 changes: 4 additions & 4 deletions Doc/lib/libfilecmp.tex
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ \section{\module{filecmp} ---
The \module{filecmp} module defines the following functions:

\begin{funcdesc}{cmp}{f1, f2\optional{, shallow\optional{, use_statcache}}}
Compare the files named \var{f1} and \var{f2}, returning \code{1} if
they seem equal, \code{0} otherwise.
Compare the files named \var{f1} and \var{f2}, returning \code{True} if
they seem equal, \code{False} otherwise.

Unless \var{shallow} is given and is false, files with identical
\function{os.stat()} signatures are taken to be equal. If
Expand Down Expand Up @@ -51,9 +51,9 @@ \section{\module{filecmp} ---
\begin{verbatim}
>>> import filecmp
>>> filecmp.cmp('libundoc.tex', 'libundoc.tex')
1
True
>>> filecmp.cmp('libundoc.tex', 'lib.tex')
0
False
\end{verbatim}


Expand Down
2 changes: 1 addition & 1 deletion Doc/lib/libmutex.tex
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ \subsection{Mutex Objects \label{mutex-objects}}

\begin{methoddesc}{testandset}{}
``Atomic'' test-and-set, grab the lock if it is not set,
and return true, otherwise, return false.
and return \code{True}, otherwise, return \code{False}.
\end{methoddesc}

\begin{methoddesc}{lock}{function, argument}
Expand Down
20 changes: 10 additions & 10 deletions Doc/lib/libposixpath.tex
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ \section{\module{os.path} ---
\end{funcdesc}

\begin{funcdesc}{exists}{path}
Return true if \var{path} refers to an existing path.
Return \code{True} if \var{path} refers to an existing path.
\end{funcdesc}

\begin{funcdesc}{expanduser}{path}
Expand Down Expand Up @@ -88,29 +88,29 @@ \section{\module{os.path} ---
\end{funcdesc}

\begin{funcdesc}{isabs}{path}
Return true if \var{path} is an absolute pathname (begins with a
Return \code{True} if \var{path} is an absolute pathname (begins with a
slash).
\end{funcdesc}

\begin{funcdesc}{isfile}{path}
Return true if \var{path} is an existing regular file. This follows
Return \code{True} if \var{path} is an existing regular file. This follows
symbolic links, so both \function{islink()} and \function{isfile()}
can be true for the same path.
\end{funcdesc}

\begin{funcdesc}{isdir}{path}
Return true if \var{path} is an existing directory. This follows
Return \code{True} if \var{path} is an existing directory. This follows
symbolic links, so both \function{islink()} and \function{isdir()} can
be true for the same path.
\end{funcdesc}

\begin{funcdesc}{islink}{path}
Return true if \var{path} refers to a directory entry that is a
symbolic link. Always false if symbolic links are not supported.
Return \code{True} if \var{path} refers to a directory entry that is a
symbolic link. Always \code{False} if symbolic links are not supported.
\end{funcdesc}

\begin{funcdesc}{ismount}{path}
Return true if pathname \var{path} is a \dfn{mount point}: a point in
Return \code{True} if pathname \var{path} is a \dfn{mount point}: a point in
a file system where a different file system has been mounted. The
function checks whether \var{path}'s parent, \file{\var{path}/..}, is
on a different device than \var{path}, or whether \file{\var{path}/..}
Expand Down Expand Up @@ -149,22 +149,22 @@ \section{\module{os.path} ---
\end{funcdesc}

\begin{funcdesc}{samefile}{path1, path2}
Return true if both pathname arguments refer to the same file or
Return \code{True} if both pathname arguments refer to the same file or
directory (as indicated by device number and i-node number).
Raise an exception if a \function{os.stat()} call on either pathname
fails.
Availability: Macintosh, \UNIX.
\end{funcdesc}

\begin{funcdesc}{sameopenfile}{fp1, fp2}
Return true if the file objects \var{fp1} and \var{fp2} refer to the
Return \code{True} if the file objects \var{fp1} and \var{fp2} refer to the
same file. The two file objects may represent different file
descriptors.
Availability: Macintosh, \UNIX.
\end{funcdesc}

\begin{funcdesc}{samestat}{stat1, stat2}
Return true if the stat tuples \var{stat1} and \var{stat2} refer to
Return \code{True} if the stat tuples \var{stat1} and \var{stat2} refer to
the same file. These structures may have been returned by
\function{fstat()}, \function{lstat()}, or \function{stat()}. This
function implements the underlying comparison used by
Expand Down
6 changes: 3 additions & 3 deletions Doc/lib/librobotparser.tex
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ \section{\module{robotparser} ---
\end{methoddesc}

\begin{methoddesc}{can_fetch}{useragent, url}
Returns true if the \var{useragent} is allowed to fetch the \var{url}
Returns \code{True} if the \var{useragent} is allowed to fetch the \var{url}
according to the rules contained in the parsed \file{robots.txt} file.
\end{methoddesc}

Expand All @@ -60,7 +60,7 @@ \section{\module{robotparser} ---
>>> rp.set_url("http://www.musi-cal.com/robots.txt")
>>> rp.read()
>>> rp.can_fetch("*", "http://www.musi-cal.com/cgi-bin/search?city=San+Francisco")
0
False
>>> rp.can_fetch("*", "http://www.musi-cal.com/")
1
True
\end{verbatim}
2 changes: 1 addition & 1 deletion Doc/lib/libtabnanny.tex
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ \section{\module{tabnanny} ---

\begin{datadesc}{verbose}
Flag indicating whether to print verbose messages.
This is set to true by the \code{-v} option if called as a script.
This is incremented by the \code{-v} option if called as a script.
\end{datadesc}


Expand Down

0 comments on commit d3dab2b

Please sign in to comment.