Kaydet (Commit) 6b35370c authored tarafından Neal Norwitz's avatar Neal Norwitz

Update docs for bool changes by Guido around April 6

üst 803a8ea4
......@@ -78,7 +78,7 @@ The remaining methods will raise \exception{IOError} if called after
the \method{close()} method has been called.
\begin{methoddesc}{isatty}{}
Returns \code{0}.
Returns \code{False}.
\end{methoddesc}
\begin{methoddesc}{seek}{pos\optional{, whence}}
......
......@@ -94,8 +94,8 @@ Return a new empty module object called \var{name}. This object is
\end{funcdesc}
\begin{funcdesc}{lock_held}{}
Return 1 if the import lock is currently held, else 0.
On platforms without threads, always return 0.
Return \code{True} if the import lock is currently held, else \code{False}.
On platforms without threads, always return \code{False}.
On platforms with threads, a thread executing an import holds an internal
lock until the import is complete.
......@@ -174,8 +174,8 @@ module called \var{name}.
\end{funcdesc}
\begin{funcdesc}{is_frozen}{name}
Return \code{1} if there is a frozen module (see
\function{init_frozen()}) called \var{name}, or \code{0} if there is
Return \code{True} if there is a frozen module (see
\function{init_frozen()}) called \var{name}, or \code{False} if there is
no such module.
\end{funcdesc}
......
......@@ -156,8 +156,8 @@ checks that the line is blank, but you can override it in a subclass.
\end{methoddesc}
\begin{methoddesc}{iscomment}{line}
Return true if the given line should be ignored entirely, just skipped.
By default this is a stub that always returns false, but you can
Return \code{True} if the given line should be ignored entirely, just skipped.
By default this is a stub that always returns \code{False}, but you can
override it in a subclass.
\end{methoddesc}
......
......@@ -1072,8 +1072,8 @@ Files have the following methods:
\end{methoddesc}
\begin{methoddesc}[file]{isatty}{}
Return true if the file is connected to a tty(-like) device, else
false. \note{If a file-like object is not associated
Return \code{True} if the file is connected to a tty(-like) device, else
\code{False}. \note{If a file-like object is not associated
with a real file, this method should \emph{not} be implemented.}
\end{methoddesc}
......@@ -1193,7 +1193,7 @@ These are not required for file-like objects, but should be
implemented if they make sense for the particular object.
\begin{memberdesc}[file]{closed}
Boolean indicating the current state of the file object. This is a
bool indicating the current state of the file object. This is a
read-only attribute; the \method{close()} method changes the value.
It may not be available on all file-like objects.
\end{memberdesc}
......
......@@ -82,8 +82,8 @@ reason for existence), and returns \code{None}. If the integer
value: if it is zero, the lock is only acquired if it can be acquired
immediately without waiting, while if it is nonzero, the lock is
acquired unconditionally as before. If an argument is present, the
return value is \code{1} if the lock is acquired successfully,
\code{0} if not.
return value is \code{True} if the lock is acquired successfully,
\code{False} if not.
\end{methoddesc}
\begin{methoddesc}[lock]{release}{}
......@@ -92,8 +92,8 @@ necessarily by the same thread.
\end{methoddesc}
\begin{methoddesc}[lock]{locked}{}
Return the status of the lock:\ \code{1} if it has been acquired by
some thread, \code{0} if not.
Return the status of the lock:\ \code{True} if it has been acquired by
some thread, \code{False} if not.
\end{methoddesc}
\strong{Caveats:}
......
......@@ -48,8 +48,8 @@ The available attributes of this module are:
\end{classdesc}
\begin{funcdesc}{is_zipfile}{filename}
Returns true if \var{filename} is a valid ZIP file based on its magic
number, otherwise returns false. This module does not currently
Returns \code{True} if \var{filename} is a valid ZIP file based on its magic
number, otherwise returns \code{False}. This module does not currently
handle ZIP files which have appended comments.
\end{funcdesc}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment