[Python-checkins] python/dist/src/Doc/lib libal.tex,1.14,1.14.8.1 libarray.tex,1.31.8.2,1.31.8.3 libcurses.tex,1.37.6.2,1.37.6.3 libdis.tex,1.33.10.3,1.33.10.4 libexcs.tex,1.43.6.1,1.43.6.2 libftplib.tex,1.33.16.1,1.33.16.2 libfuncs.tex,1.100.4.15,1.100.4.16 liblocale.tex,1.27.8.1,1.27.8.2 libmimetools.tex,1.20.16.2,1.20.16.3 libos.tex,1.74.2.1.2.14,1.74.2.1.2.15 libprofile.tex,1.39,1.39.10.1 librandom.tex,1.25.18.4,1.25.18.5 librepr.tex,1.3,1.3.24.1 libstdtypes.tex,1.80.6.22,1.80.6.23 liburllib2.tex,1.6.8.2,1.6.8.3 libwinreg.tex,1.7.18.2,1.7.18.3
rhettinger@users.sourceforge.net
rhettinger@users.sourceforge.net
Thu, 15 May 2003 20:08:42 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv20225
Modified Files:
Tag: release22-maint
libal.tex libarray.tex libcurses.tex libdis.tex libexcs.tex
libftplib.tex libfuncs.tex liblocale.tex libmimetools.tex
libos.tex libprofile.tex librandom.tex librepr.tex
libstdtypes.tex liburllib2.tex libwinreg.tex
Log Message:
Fix nits found by Tools\scripts\texcheck.py
Index: libal.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libal.tex,v
retrieving revision 1.14
retrieving revision 1.14.8.1
diff -C2 -d -r1.14 -r1.14.8.1
*** libal.tex 20 Oct 2001 04:24:09 -0000 1.14
--- libal.tex 16 May 2003 03:08:32 -0000 1.14.8.1
***************
*** 63,67 ****
\subsection{Configuration Objects \label{al-config-objects}}
! Configuration objects (returned by \function{newconfig()} have the
following methods:
--- 63,67 ----
\subsection{Configuration Objects \label{al-config-objects}}
! Configuration objects (returned by \function{newconfig()}) have the
following methods:
Index: libarray.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libarray.tex,v
retrieving revision 1.31.8.2
retrieving revision 1.31.8.3
diff -C2 -d -r1.31.8.2 -r1.31.8.3
*** libarray.tex 4 Apr 2002 14:04:03 -0000 1.31.8.2
--- libarray.tex 16 May 2003 03:08:32 -0000 1.31.8.3
***************
*** 214,217 ****
about Numerical Python. (A PDF version of the NumPy manual
is available at
! \url{http://numpy.sourceforge.net/numdoc/numdoc.pdf}.}
\end{seealso}
--- 214,217 ----
about Numerical Python. (A PDF version of the NumPy manual
is available at
! \url{http://numpy.sourceforge.net/numdoc/numdoc.pdf}.)}
\end{seealso}
Index: libcurses.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcurses.tex,v
retrieving revision 1.37.6.2
retrieving revision 1.37.6.3
diff -C2 -d -r1.37.6.2 -r1.37.6.3
*** libcurses.tex 12 Jan 2003 14:57:53 -0000 1.37.6.2
--- libcurses.tex 16 May 2003 03:08:32 -0000 1.37.6.3
***************
*** 997,1001 ****
\begin{methoddesc}[window]{timeout}{delay}
Sets blocking or non-blocking read behavior for the window. If
! \var{delay} is negative, blocking read is used, which will wait
indefinitely for input). If \var{delay} is zero, then non-blocking
read is used, and -1 will be returned by \method{getch()} if no input
--- 997,1001 ----
\begin{methoddesc}[window]{timeout}{delay}
Sets blocking or non-blocking read behavior for the window. If
! \var{delay} is negative, blocking read is used (which will wait
indefinitely for input). If \var{delay} is zero, then non-blocking
read is used, and -1 will be returned by \method{getch()} if no input
Index: libdis.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdis.tex,v
retrieving revision 1.33.10.3
retrieving revision 1.33.10.4
diff -C2 -d -r1.33.10.3 -r1.33.10.4
*** libdis.tex 5 Aug 2002 23:35:02 -0000 1.33.10.3
--- libdis.tex 16 May 2003 03:08:33 -0000 1.33.10.4
***************
*** 512,516 ****
\begin{opcodedesc}{LOAD_ATTR}{namei}
! Replaces TOS with \code{getattr(TOS, co_names[\var{namei}]}.
\end{opcodedesc}
--- 512,516 ----
\begin{opcodedesc}{LOAD_ATTR}{namei}
! Replaces TOS with \code{getattr(TOS, co_names[\var{namei}])}.
\end{opcodedesc}
Index: libexcs.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libexcs.tex,v
retrieving revision 1.43.6.1
retrieving revision 1.43.6.2
diff -C2 -d -r1.43.6.1 -r1.43.6.2
*** libexcs.tex 27 Aug 2002 23:54:57 -0000 1.43.6.1
--- libexcs.tex 16 May 2003 03:08:33 -0000 1.43.6.2
***************
*** 189,193 ****
interrupts is made regularly.
% XXXJH xrefs here
! Interrupts typed when a built-in function \function{input()} or
\function{raw_input()}) is waiting for input also raise this
exception.
--- 189,193 ----
interrupts is made regularly.
% XXXJH xrefs here
! Interrupts typed when a built-in function (\function{input()} or
\function{raw_input()}) is waiting for input also raise this
exception.
Index: libftplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libftplib.tex,v
retrieving revision 1.33.16.1
retrieving revision 1.33.16.2
diff -C2 -d -r1.33.16.1 -r1.33.16.2
*** libftplib.tex 28 Dec 2001 04:35:10 -0000 1.33.16.1
--- libftplib.tex 16 May 2003 03:08:34 -0000 1.33.16.2
***************
*** 165,169 ****
\var{command} should be an appropriate \samp{RETR} command (see
\method{retrbinary()} or a \samp{LIST} command (usually just the string
! \code{'LIST'}). The \var{callback} function is called for each line,
with the trailing CRLF stripped. The default \var{callback} prints
the line to \code{sys.stdout}.
--- 165,169 ----
\var{command} should be an appropriate \samp{RETR} command (see
\method{retrbinary()} or a \samp{LIST} command (usually just the string
! \code{'LIST'})). The \var{callback} function is called for each line,
with the trailing CRLF stripped. The default \var{callback} prints
the line to \code{sys.stdout}.
***************
*** 285,289 ****
Close the connection unilaterally. This should not be applied to an
already closed connection (such as after a successful call to
! \method{quit()}. After this call the \class{FTP} instance should not
be used any more (after a call to \method{close()} or
\method{quit()} you cannot reopen the connection by issuing another
--- 285,289 ----
Close the connection unilaterally. This should not be applied to an
already closed connection (such as after a successful call to
! \method{quit()}). After this call the \class{FTP} instance should not
be used any more (after a call to \method{close()} or
\method{quit()} you cannot reopen the connection by issuing another
Index: libfuncs.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libfuncs.tex,v
retrieving revision 1.100.4.15
retrieving revision 1.100.4.16
diff -C2 -d -r1.100.4.15 -r1.100.4.16
*** libfuncs.tex 2 Feb 2003 19:08:58 -0000 1.100.4.15
--- libfuncs.tex 16 May 2003 03:08:34 -0000 1.100.4.16
***************
*** 674,678 ****
\begin{funcdesc}{property}{\optional{fget\optional{, fset\optional{, fdel\optional{, doc}}}}}
Return a property attribute for new-style classes (classes that
! derive from \function{object}.
\var{fget} is a function for getting an attribute value, likewise
--- 674,678 ----
\begin{funcdesc}{property}{\optional{fget\optional{, fset\optional{, fdel\optional{, doc}}}}}
Return a property attribute for new-style classes (classes that
! derive from \function{object}).
\var{fget} is a function for getting an attribute value, likewise
Index: liblocale.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liblocale.tex,v
retrieving revision 1.27.8.1
retrieving revision 1.27.8.2
diff -C2 -d -r1.27.8.1 -r1.27.8.2
*** liblocale.tex 13 Jun 2002 17:54:44 -0000 1.27.8.1
--- liblocale.tex 16 May 2003 03:08:34 -0000 1.27.8.2
***************
*** 413,418 ****
If, when coding a module for general use, you need a locale
independent version of an operation that is affected by the locale
! (e.g. \function{string.lower()}, or certain formats used with
! \function{time.strftime()})), you will have to find a way to do it
without using the standard library routine. Even better is convincing
yourself that using locale settings is okay. Only as a last resort
--- 413,418 ----
If, when coding a module for general use, you need a locale
independent version of an operation that is affected by the locale
! (such as \function{string.lower()}, or certain formats used with
! \function{time.strftime()}), you will have to find a way to do it
without using the standard library routine. Even better is convincing
yourself that using locale settings is okay. Only as a last resort
Index: libmimetools.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libmimetools.tex,v
retrieving revision 1.20.16.2
retrieving revision 1.20.16.3
diff -C2 -d -r1.20.16.2 -r1.20.16.3
*** libmimetools.tex 6 Oct 2002 02:32:34 -0000 1.20.16.2
--- libmimetools.tex 16 May 2003 03:08:34 -0000 1.20.16.3
***************
*** 86,90 ****
\begin{methoddesc}{getparam}{name}
Return the \var{value} of the first parameter (as returned by
! \method{getplist()} of the form \samp{\var{name}=\var{value}} for the
given \var{name}. If \var{value} is surrounded by quotes of the form
`\code{<}...\code{>}' or `\code{"}...\code{"}', these are removed.
--- 86,90 ----
\begin{methoddesc}{getparam}{name}
Return the \var{value} of the first parameter (as returned by
! \method{getplist()}) of the form \samp{\var{name}=\var{value}} for the
given \var{name}. If \var{value} is surrounded by quotes of the form
`\code{<}...\code{>}' or `\code{"}...\code{"}', these are removed.
Index: libos.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libos.tex,v
retrieving revision 1.74.2.1.2.14
retrieving revision 1.74.2.1.2.15
diff -C2 -d -r1.74.2.1.2.14 -r1.74.2.1.2.15
*** libos.tex 23 Apr 2003 20:14:06 -0000 1.74.2.1.2.14
--- libos.tex 16 May 2003 03:08:34 -0000 1.74.2.1.2.15
***************
*** 439,443 ****
If you're starting with a Python file object \var{f}, first do
! \code{\var{f}.flush()}, and then do \code{os.fsync(\var{f}.fileno()},
to ensure that all internal buffers associated with \var{f} are written
to disk.
--- 439,443 ----
If you're starting with a Python file object \var{f}, first do
! \code{\var{f}.flush()}, and then do \code{os.fsync(\var{f}.fileno())},
to ensure that all internal buffers associated with \var{f} are written
to disk.
***************
*** 788,792 ****
\member{st_ino} (inode number),
\member{st_dev} (device),
! \member{st_nlink} (number of hard links,
\member{st_uid} (user ID of owner),
\member{st_gid} (group ID of owner),
--- 788,792 ----
\member{st_ino} (inode number),
\member{st_dev} (device),
! \member{st_nlink} (number of hard links),
\member{st_uid} (user ID of owner),
\member{st_gid} (group ID of owner),
Index: libprofile.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libprofile.tex,v
retrieving revision 1.39
retrieving revision 1.39.10.1
diff -C2 -d -r1.39 -r1.39.10.1
*** libprofile.tex 9 Oct 2001 20:54:23 -0000 1.39
--- libprofile.tex 16 May 2003 03:08:34 -0000 1.39.10.1
***************
*** 456,460 ****
The order of the printing is based on the last \method{sort_stats()}
operation done on the object (subject to caveats in \method{add()} and
! \method{strip_dirs()}.
The arguments provided (if any) can be used to limit the list down to
--- 456,460 ----
The order of the printing is based on the last \method{sort_stats()}
operation done on the object (subject to caveats in \method{add()} and
! \method{strip_dirs()}).
The arguments provided (if any) can be used to limit the list down to
Index: librandom.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/librandom.tex,v
retrieving revision 1.25.18.4
retrieving revision 1.25.18.5
diff -C2 -d -r1.25.18.4 -r1.25.18.5
*** librandom.tex 5 Oct 2002 15:00:09 -0000 1.25.18.4
--- librandom.tex 16 May 2003 03:08:35 -0000 1.25.18.5
***************
*** 77,81 ****
safely in parallel. So long as no thread calls its \code{g.random()}
more than a million times (the second argument to
! \function{create_generators()}, the sequences seen by each thread will
not overlap. The period of the underlying Wichmann-Hill generator
limits how far this technique can be pushed.
--- 77,81 ----
safely in parallel. So long as no thread calls its \code{g.random()}
more than a million times (the second argument to
! \function{create_generators()}), the sequences seen by each thread will
not overlap. The period of the underlying Wichmann-Hill generator
limits how far this technique can be pushed.
Index: librepr.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/librepr.tex,v
retrieving revision 1.3
retrieving revision 1.3.24.1
diff -C2 -d -r1.3 -r1.3.24.1
*** librepr.tex 10 Oct 2000 17:03:45 -0000 1.3
--- librepr.tex 16 May 2003 03:08:36 -0000 1.3.24.1
***************
*** 97,101 ****
with a name based on the type name. In the method name, \var{type}
is replaced by
! \code{string.join(string.split(type(\var{obj}).__name__, '_')}.
Dispatch to these methods is handled by \method{repr1()}.
Type-specific methods which need to recursively format a value
--- 97,101 ----
with a name based on the type name. In the method name, \var{type}
is replaced by
! \code{string.join(string.split(type(\var{obj}).__name__), '_')}.
Dispatch to these methods is handled by \method{repr1()}.
Type-specific methods which need to recursively format a value
Index: libstdtypes.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libstdtypes.tex,v
retrieving revision 1.80.6.22
retrieving revision 1.80.6.23
diff -C2 -d -r1.80.6.22 -r1.80.6.23
*** libstdtypes.tex 30 Apr 2003 16:43:51 -0000 1.80.6.22
--- libstdtypes.tex 16 May 2003 03:08:36 -0000 1.80.6.23
***************
*** 1045,1049 ****
\ttindex{popitem()}
\ttindex{iteritems()}
! \ttindex{iterkeys)}
\ttindex{itervalues()}}
--- 1045,1049 ----
\ttindex{popitem()}
\ttindex{iteritems()}
! \ttindex{iterkeys()}
\ttindex{itervalues()}}
***************
*** 1346,1350 ****
possible (you can write \code{\var{m}.__dict__['a'] = 1}, which
defines \code{\var{m}.a} to be \code{1}, but you can't write
! \code{\var{m}.__dict__ = \{\}}.
Modules built into the interpreter are written like this:
--- 1346,1350 ----
possible (you can write \code{\var{m}.__dict__['a'] = 1}, which
defines \code{\var{m}.a} to be \code{1}, but you can't write
! \code{\var{m}.__dict__ = \{\}}).
Modules built into the interpreter are written like this:
Index: liburllib2.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liburllib2.tex,v
retrieving revision 1.6.8.2
retrieving revision 1.6.8.3
diff -C2 -d -r1.6.8.2 -r1.6.8.3
*** liburllib2.tex 25 Apr 2003 15:29:22 -0000 1.6.8.2
--- liburllib2.tex 16 May 2003 03:08:36 -0000 1.6.8.3
***************
*** 298,302 ****
Arguments, return values and exceptions raised are the same as those
of \function{urlopen()} (which simply calls the \method{open()} method
! on the default installed \class{OpenerDirector}.
\end{methoddesc}
--- 298,302 ----
Arguments, return values and exceptions raised are the same as those
of \function{urlopen()} (which simply calls the \method{open()} method
! on the default installed \class{OpenerDirector}).
\end{methoddesc}
Index: libwinreg.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libwinreg.tex,v
retrieving revision 1.7.18.2
retrieving revision 1.7.18.3
diff -C2 -d -r1.7.18.2 -r1.7.18.3
*** libwinreg.tex 25 Jun 2002 15:25:53 -0000 1.7.18.2
--- libwinreg.tex 16 May 2003 03:08:36 -0000 1.7.18.3
***************
*** 26,32 ****
The hkey argument specifies a previously opened key.
! Note that if \var{hkey} is not closed using this method, (or the
! \method{handle.Close()} closed when the \var{hkey} object is
! destroyed by Python.
\end{funcdesc}
--- 26,32 ----
The hkey argument specifies a previously opened key.
! Note that if \var{hkey} is not closed using this method or the
! \method{handle.Close()} method, it is closed when the \var{hkey} object
! is destroyed by Python.
\end{funcdesc}
***************
*** 388,393 ****
underlying Windows handle value.
! Handle objects can be converted to an integer (eg, using the
! builtin \function{int()} function, in which case the underlying
Windows handle value is returned. You can also use the
\method{Detach()} method to return the integer handle, and
--- 388,393 ----
underlying Windows handle value.
! Handle objects can be converted to an integer (perhaps using the
! builtin \function{int()} function), in which case the underlying
Windows handle value is returned. You can also use the
\method{Detach()} method to return the integer handle, and