diff options
author | Neal Norwitz <nnorwitz@gmail.com> | 2002-04-05 02:21:09 (GMT) |
---|---|---|
committer | Neal Norwitz <nnorwitz@gmail.com> | 2002-04-05 02:21:09 (GMT) |
commit | d3dab2b19288139dfa6fc7c4f3302b734573f9dd (patch) | |
tree | 539ad29bdea7cefa53f5b0cd844005a9ec264687 /Doc/lib | |
parent | c334df5727ad9cb4a5de85f69b03808b9856b55c (diff) | |
download | cpython-d3dab2b19288139dfa6fc7c4f3302b734573f9dd.zip cpython-d3dab2b19288139dfa6fc7c4f3302b734573f9dd.tar.gz cpython-d3dab2b19288139dfa6fc7c4f3302b734573f9dd.tar.bz2 |
Update doc to reflect Tim's changes to bool.
Diffstat (limited to 'Doc/lib')
-rw-r--r-- | Doc/lib/libasyncore.tex | 4 | ||||
-rw-r--r-- | Doc/lib/libcfgparser.tex | 3 | ||||
-rw-r--r-- | Doc/lib/libcode.tex | 10 | ||||
-rw-r--r-- | Doc/lib/libfilecmp.tex | 8 | ||||
-rw-r--r-- | Doc/lib/libmutex.tex | 2 | ||||
-rw-r--r-- | Doc/lib/libposixpath.tex | 20 | ||||
-rw-r--r-- | Doc/lib/librobotparser.tex | 6 | ||||
-rw-r--r-- | Doc/lib/libtabnanny.tex | 2 |
8 files changed, 28 insertions, 27 deletions
diff --git a/Doc/lib/libasyncore.tex b/Doc/lib/libasyncore.tex index cae972d..a85998e 100644 --- a/Doc/lib/libasyncore.tex +++ b/Doc/lib/libasyncore.tex @@ -118,14 +118,14 @@ def handle_write(self): \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} diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex index ff01fde..c50b456 100644 --- a/Doc/lib/libcfgparser.tex +++ b/Doc/lib/libcfgparser.tex @@ -211,7 +211,8 @@ If the option existed to be removed, return 1; otherwise return 0. \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} diff --git a/Doc/lib/libcode.tex b/Doc/lib/libcode.tex index ff6bde2..7bde19b 100644 --- a/Doc/lib/libcode.tex +++ b/Doc/lib/libcode.tex @@ -80,18 +80,18 @@ The input is incorrect; \function{compile_command()} raised an 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 @@ -155,8 +155,8 @@ newlines. The line is appended to a buffer and the interpreter's 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} diff --git a/Doc/lib/libfilecmp.tex b/Doc/lib/libfilecmp.tex index 6e474ae..ddb74ab 100644 --- a/Doc/lib/libfilecmp.tex +++ b/Doc/lib/libfilecmp.tex @@ -12,8 +12,8 @@ directories, with various optional time/correctness trade-offs. 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 @@ -51,9 +51,9 @@ Example: \begin{verbatim} >>> import filecmp >>> filecmp.cmp('libundoc.tex', 'libundoc.tex') -1 +True >>> filecmp.cmp('libundoc.tex', 'lib.tex') -0 +False \end{verbatim} diff --git a/Doc/lib/libmutex.tex b/Doc/lib/libmutex.tex index e2c34f2..4893690 100644 --- a/Doc/lib/libmutex.tex +++ b/Doc/lib/libmutex.tex @@ -41,7 +41,7 @@ Check whether the mutex is locked. \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} diff --git a/Doc/lib/libposixpath.tex b/Doc/lib/libposixpath.tex index a59b5a7..4bbb5b6 100644 --- a/Doc/lib/libposixpath.tex +++ b/Doc/lib/libposixpath.tex @@ -42,7 +42,7 @@ half of the pair returned by \code{split(\var{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} @@ -88,29 +88,29 @@ Return the size, in bytes, of \var{filename}. Raise \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}/..} @@ -149,7 +149,7 @@ Availability: \UNIX. \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. @@ -157,14 +157,14 @@ 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 diff --git a/Doc/lib/librobotparser.tex b/Doc/lib/librobotparser.tex index 0008dde..8bf1ae8 100644 --- a/Doc/lib/librobotparser.tex +++ b/Doc/lib/librobotparser.tex @@ -35,7 +35,7 @@ Parses the lines argument. \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} @@ -60,7 +60,7 @@ The following example demonstrates basic use of the RobotFileParser class. >>> 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} diff --git a/Doc/lib/libtabnanny.tex b/Doc/lib/libtabnanny.tex index 7985d9e..02d4b7b 100644 --- a/Doc/lib/libtabnanny.tex +++ b/Doc/lib/libtabnanny.tex @@ -29,7 +29,7 @@ in future releases; such changes may not be backward compatible.} \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} |