[Python-checkins] CVS: python/dist/src/Doc/lib libal.tex,1.13,1.14 libarray.tex,1.30,1.31 libcgihttp.tex,1.5,1.6 libcmpcache.tex,1.5,1.6 libcodecs.tex,1.6,1.7 libcurses.tex,1.34,1.35 libdl.tex,1.3,1.4 libfpformat.tex,1.3,1.4 libgetopt.tex,1.18,1.19 libgl.tex,1.16,1.17 libhttplib.tex,1.25,1.26 libinspect.tex,1.7,1.8 liblocale.tex,1.26,1.27 libmarshal.tex,1.20,1.21 liboperator.tex,1.20,1.21 libpanel.tex,1.11,1.12 libpickle.tex,1.29,1.30 libposix.tex,1.58,1.59 libposixfile.tex,1.23,1.24 libposixpath.tex,1.20,1.21 libpwd.tex,1.12,1.13 libre.tex,1.68,1.69 librexec.tex,1.17,1.18 libselect.tex,1.18,1.19 libsmtplib.tex,1.20,1.21 libsocket.tex,1.56,1.57 libstdtypes.tex,1.71,1.72 libstdwin.tex,1.24,1.25 libstring.tex,1.44,1.45 libsys.tex,1.53,1.54 libtabnanny.tex,1.1,1.2 libtime.tex,1.45,1.46 libunittest.tex,1.6,1.7 liburllib.tex,1.39,1.40 liburllib2.tex,1.4,1.5 libwhrandom.tex,1.14,1.15 libwinsound.tex,1.11,1.12 xmldom.tex,1.14,1.15 xmlsaxhandler.tex,1.4,1.5
Fred L. Drake
fdrake@users.sourceforge.net
Fri, 19 Oct 2001 21:24:12 -0700
- Previous message: [Python-checkins] CVS: python/dist/src/Doc/ref ref3.tex,1.75,1.76 ref7.tex,1.28,1.29
- Next message: [Python-checkins] CVS: python/dist/src Makefile.pre.in,1.64,1.65 configure,1.266,1.267 configure.in,1.274,1.275
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv30080/lib
Modified Files:
libal.tex libarray.tex libcgihttp.tex libcmpcache.tex
libcodecs.tex libcurses.tex libdl.tex libfpformat.tex
libgetopt.tex libgl.tex libhttplib.tex libinspect.tex
liblocale.tex libmarshal.tex liboperator.tex libpanel.tex
libpickle.tex libposix.tex libposixfile.tex libposixpath.tex
libpwd.tex libre.tex librexec.tex libselect.tex libsmtplib.tex
libsocket.tex libstdtypes.tex libstdwin.tex libstring.tex
libsys.tex libtabnanny.tex libtime.tex libunittest.tex
liburllib.tex liburllib2.tex libwhrandom.tex libwinsound.tex
xmldom.tex xmlsaxhandler.tex
Log Message:
Use the \note and \warning macros where appropriate.
Index: libal.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libal.tex,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** libal.tex 1999/04/22 21:23:21 1.13
--- libal.tex 2001/10/20 04:24:09 1.14
***************
*** 21,25 ****
\refmodule[al-constants]{AL}\refstmodindex{AL}, see below.
! \strong{Warning:} the current version of the audio library may dump core
when bad argument values are passed rather than returning an error
status. Unfortunately, since the precise circumstances under which
--- 21,25 ----
\refmodule[al-constants]{AL}\refstmodindex{AL}, see below.
! \warning{The current version of the audio library may dump core
when bad argument values are passed rather than returning an error
status. Unfortunately, since the precise circumstances under which
***************
*** 27,31 ****
interface can provide no protection against this kind of problems.
(One example is specifying an excessive queue size --- there is no
! documented upper limit.)
The module defines the following functions:
--- 27,31 ----
interface can provide no protection against this kind of problems.
(One example is specifying an excessive queue size --- there is no
! documented upper limit.)}
The module defines the following functions:
Index: libarray.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libarray.tex,v
retrieving revision 1.30
retrieving revision 1.31
diff -C2 -d -r1.30 -r1.31
*** libarray.tex 2001/08/01 16:50:49 1.30
--- libarray.tex 2001/10/20 04:24:09 1.31
***************
*** 78,87 ****
length-changing operations are applied to it.
! \strong{Note:} When using array objects from code written in C or
\Cpp{} (the only way to effectively make use of this information), it
makes more sense to use the buffer interface supported by array
objects. This method is maintained for backward compatibility and
should be avoided in new code. The buffer interface is documented in
! the \citetitle[../api/newTypes.html]{Python/C API Reference Manual}.
\end{methoddesc}
--- 78,87 ----
length-changing operations are applied to it.
! \note{When using array objects from code written in C or
\Cpp{} (the only way to effectively make use of this information), it
makes more sense to use the buffer interface supported by array
objects. This method is maintained for backward compatibility and
should be avoided in new code. The buffer interface is documented in
! the \citetitle[../api/newTypes.html]{Python/C API Reference Manual}.}
\end{methoddesc}
Index: libcgihttp.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcgihttp.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** libcgihttp.tex 2000/12/01 15:25:23 1.5
--- libcgihttp.tex 2001/10/20 04:24:09 1.6
***************
*** 16,21 ****
run CGI scripts.
! \strong{Note:} This module is \UNIX{} dependent since it creates the
! CGI process using \function{os.fork()} and \function{os.exec()}.
The \module{CGIHTTPServer} module defines the following class:
--- 16,21 ----
run CGI scripts.
! \note{This module is \UNIX{} dependent since it creates the
! CGI process using \function{os.fork()} and \function{os.exec()}.}
The \module{CGIHTTPServer} module defines the following class:
Index: libcmpcache.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcmpcache.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** libcmpcache.tex 2001/01/25 17:29:18 1.5
--- libcmpcache.tex 2001/10/20 04:24:09 1.6
***************
*** 14,21 ****
difference).
! \strong{Note:} Using the \refmodule{statcache} module to provide
\function{stat()} information results in trashing the cache
invalidation mechanism: results are not as reliable. To ensure
``current'' results, use \function{cmp.cmp()} instead of the version
defined in this module, or use \function{statcache.forget()} to
! invalidate the appropriate entries.
--- 14,21 ----
difference).
! \note{Using the \refmodule{statcache} module to provide
\function{stat()} information results in trashing the cache
invalidation mechanism: results are not as reliable. To ensure
``current'' results, use \function{cmp.cmp()} instead of the version
defined in this module, or use \function{statcache.forget()} to
! invalidate the appropriate entries.}
Index: libcodecs.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcodecs.tex,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** libcodecs.tex 2001/09/19 11:33:31 1.6
--- libcodecs.tex 2001/10/20 04:24:09 1.7
***************
*** 104,111 ****
a wrapped version providing transparent encoding/decoding.
! \strong{Note:} The wrapped version will only accept the object format
defined by the codecs, i.e.\ Unicode objects for most built-in
codecs. Output is also codec-dependent and will usually be Unicode as
! well.
\var{encoding} specifies the encoding which is to be used for the
--- 104,111 ----
a wrapped version providing transparent encoding/decoding.
! \note{The wrapped version will only accept the object format
defined by the codecs, i.e.\ Unicode objects for most built-in
codecs. Output is also codec-dependent and will usually be Unicode as
! well.}
\var{encoding} specifies the encoding which is to be used for the
***************
*** 336,340 ****
decoded data.
! Note: Unlike the \method{readlines()} method, this method inherits
the line breaking knowledge from the underlying stream's
\method{readline()} method -- there is currently no support for line
--- 336,340 ----
decoded data.
! Unlike the \method{readlines()} method, this method inherits
the line breaking knowledge from the underlying stream's
\method{readline()} method -- there is currently no support for line
Index: libcurses.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcurses.tex,v
retrieving revision 1.34
retrieving revision 1.35
diff -C2 -d -r1.34 -r1.35
*** libcurses.tex 2001/07/12 02:09:51 1.34
--- libcurses.tex 2001/10/20 04:24:09 1.35
***************
*** 50,56 ****
\end{excdesc}
! \strong{Note:} Whenever \var{x} or \var{y} arguments to a function
or a method are optional, they default to the current cursor location.
! Whenever \var{attr} is optional, it defaults to \constant{A_NORMAL}.
The module \module{curses} defines the following functions:
--- 50,56 ----
\end{excdesc}
! \note{Whenever \var{x} or \var{y} arguments to a function
or a method are optional, they default to the current cursor location.
! Whenever \var{attr} is optional, it defaults to \constant{A_NORMAL}.}
The module \module{curses} defines the following functions:
***************
*** 517,522 ****
\begin{funcdesc}{ungetch}{ch}
Push \var{ch} so the next \method{getch()} will return it.
! \strong{Note:} only one \var{ch} can be pushed before \method{getch()}
! is called.
\end{funcdesc}
--- 517,522 ----
\begin{funcdesc}{ungetch}{ch}
Push \var{ch} so the next \method{getch()} will return it.
! \note{Only one \var{ch} can be pushed before \method{getch()}
! is called.}
\end{funcdesc}
***************
*** 543,550 ****
\begin{methoddesc}{addch}{\optional{y, x,} ch\optional{, attr}}
! \strong{Note:} A \emph{character} means a C character (an
\ASCII{} code), rather then a Python character (a string of length 1).
(This note is true whenever the documentation mentions a character.)
! The builtin \function{ord()} is handy for conveying strings to codes.
Paint character \var{ch} at \code{(\var{y}, \var{x})} with attributes
--- 543,550 ----
\begin{methoddesc}{addch}{\optional{y, x,} ch\optional{, attr}}
! \note{A \emph{character} means a C character (an
\ASCII{} code), rather then a Python character (a string of length 1).
(This note is true whenever the documentation mentions a character.)
! The builtin \function{ord()} is handy for conveying strings to codes.}
Paint character \var{ch} at \code{(\var{y}, \var{x})} with attributes
***************
*** 615,621 ****
raised.
! \strong{Note:} A \code{0} value for any parameter will cause the
default character to be used for that parameter. Keyword parameters
! can \emph{not} be used. The defaults are listed in this table:
\begin{tableiii}{l|l|l}{var}{Parameter}{Description}{Default value}
--- 615,621 ----
raised.
! \note{A \code{0} value for any parameter will cause the
default character to be used for that parameter. Keyword parameters
! can \emph{not} be used. The defaults are listed in this table:}
\begin{tableiii}{l|l|l}{var}{Parameter}{Description}{Default value}
***************
*** 1183,1188 ****
is no graphic available, curses falls back on a crude printable ASCII
approximation.
! \strong{Note:} These are available only after \function{initscr()} has
! been called.
\begin{longtableii}{l|l}{code}{ACS code}{Meaning}
--- 1183,1188 ----
is no graphic available, curses falls back on a crude printable ASCII
approximation.
! \note{These are available only after \function{initscr()} has
! been called.}
\begin{longtableii}{l|l}{code}{ACS code}{Meaning}
Index: libdl.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdl.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** libdl.tex 2000/12/01 15:25:23 1.3
--- libdl.tex 2001/10/20 04:24:09 1.4
***************
*** 11,20 ****
the program to call arbitrary functions in such a library.
! \strong{Note:} This module will not work unless
! \begin{verbatim}
! sizeof(int) == sizeof(long) == sizeof(char *)
! \end{verbatim}
If this is not the case, \exception{SystemError} will be raised on
! import.
The \module{dl} module defines the following function:
--- 11,18 ----
the program to call arbitrary functions in such a library.
! \note{This module will not work unless
! \code{sizeof(int) == sizeof(long) == sizeof(char *)}
If this is not the case, \exception{SystemError} will be raised on
! import.}
The \module{dl} module defines the following function:
Index: libfpformat.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libfpformat.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** libfpformat.tex 2000/12/01 15:25:23 1.3
--- libfpformat.tex 2001/10/20 04:24:09 1.4
***************
*** 9,14 ****
The \module{fpformat} module defines functions for dealing with
floating point numbers representations in 100\% pure
! Python. \strong{Note:} This module is unneeded: everything here could
! be done via the \code{\%} string interpolation operator.
The \module{fpformat} module defines the following functions and an
--- 9,14 ----
The \module{fpformat} module defines functions for dealing with
floating point numbers representations in 100\% pure
! Python. \note{This module is unneeded: everything here could
! be done via the \code{\%} string interpolation operator.}
The \module{fpformat} module defines the following functions and an
Index: libgetopt.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libgetopt.tex,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** libgetopt.tex 2001/04/18 03:18:57 1.18
--- libgetopt.tex 2001/10/20 04:24:09 1.19
***************
*** 26,32 ****
\cfunction{getopt()} uses).
! \strong{Note:} Unlike GNU \cfunction{getopt()}, after a non-option
argument, all further arguments are considered also non-options.
! This is similar to the way non-GNU \UNIX{} systems work.
\var{long_options}, if specified, must be a list of strings with the
--- 26,32 ----
\cfunction{getopt()} uses).
! \note{Unlike GNU \cfunction{getopt()}, after a non-option
argument, all further arguments are considered also non-options.
! This is similar to the way non-GNU \UNIX{} systems work.}
\var{long_options}, if specified, must be a list of strings with the
Index: libgl.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libgl.tex,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -d -r1.16 -r1.17
*** libgl.tex 2001/09/06 19:23:03 1.16
--- libgl.tex 2001/10/20 04:24:09 1.17
***************
*** 11,19 ****
It is available only on Silicon Graphics machines.
! \strong{Warning:}
! Some illegal calls to the GL library cause the Python interpreter to dump
! core.
In particular, the use of most GL calls is unsafe before the first
! window is opened.
The module is too large to document here in its entirety, but the
--- 11,18 ----
It is available only on Silicon Graphics machines.
! \warning{Some illegal calls to the GL library cause the Python
! interpreter to dump core.
In particular, the use of most GL calls is unsafe before the first
! window is opened.}
The module is too large to document here in its entirety, but the
Index: libhttplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libhttplib.tex,v
retrieving revision 1.25
retrieving revision 1.26
diff -C2 -d -r1.25 -r1.26
*** libhttplib.tex 2001/09/25 16:32:02 1.25
--- libhttplib.tex 2001/10/20 04:24:09 1.26
***************
*** 10,16 ****
HTTP and HTTPS protocols. It is normally not used directly --- the
module \refmodule{urllib}\refstmodindex{urllib} uses it to handle URLs
! that use HTTP and HTTPS. \strong{Note:} HTTPS support is only
available if the \refmodule{socket} module was compiled with SSL
! support.
The module defines one class, \class{HTTP}:
--- 10,16 ----
HTTP and HTTPS protocols. It is normally not used directly --- the
module \refmodule{urllib}\refstmodindex{urllib} uses it to handle URLs
! that use HTTP and HTTPS. \note{HTTPS support is only
available if the \refmodule{socket} module was compiled with SSL
! support.}
The module defines one class, \class{HTTP}:
Index: libinspect.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libinspect.tex,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** libinspect.tex 2001/10/18 14:26:08 1.7
--- libinspect.tex 2001/10/20 04:24:09 1.8
***************
*** 273,277 ****
context to return, which are centered around the current line.
! \strong{Warning:} Keeping references to frame objects, as found in
the first element of the frame records these functions return, can
cause your program to create reference cycles. Once a reference cycle
--- 273,277 ----
context to return, which are centered around the current line.
! \warning{Keeping references to frame objects, as found in
the first element of the frame records these functions return, can
cause your program to create reference cycles. Once a reference cycle
***************
*** 281,285 ****
created, it is important to ensure they are explicitly broken to avoid
the delayed destruction of objects and increased memory consumption
! which occurs.
\begin{funcdesc}{getframeinfo}{frame\optional{, context}}
--- 281,285 ----
created, it is important to ensure they are explicitly broken to avoid
the delayed destruction of objects and increased memory consumption
! which occurs.}
\begin{funcdesc}{getframeinfo}{frame\optional{, context}}
Index: liblocale.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liblocale.tex,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -d -r1.26 -r1.27
*** liblocale.tex 2001/09/27 04:16:27 1.26
--- liblocale.tex 2001/10/20 04:24:09 1.27
***************
*** 299,306 ****
\begin{datadesc}{DAY_1 ... DAY_7}
! Return name of the n-th day of the week. \strong{Warning:} this
follows the US convention of \constant{DAY_1} being Sunday, not the
international convention (ISO 8601) that Monday is the first day of
! the week.
\end{datadesc}
--- 299,306 ----
\begin{datadesc}{DAY_1 ... DAY_7}
! Return name of the n-th day of the week. \warning{This
follows the US convention of \constant{DAY_1} being Sunday, not the
international convention (ISO 8601) that Monday is the first day of
! the week.}
\end{datadesc}
***************
*** 328,334 ****
Return a regular expression that can be used with the regex
function to recognize a positive response to a yes/no question.
! \strong{Warning:} the expression is in the syntax suitable for the
\cfunction{regex()} function from the C library, which might differ
! from the syntax used in \refmodule{re}.
\end{datadesc}
--- 328,334 ----
Return a regular expression that can be used with the regex
function to recognize a positive response to a yes/no question.
! \warning{The expression is in the syntax suitable for the
\cfunction{regex()} function from the C library, which might differ
! from the syntax used in \refmodule{re}.}
\end{datadesc}
Index: libmarshal.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libmarshal.tex,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** libmarshal.tex 2001/09/14 20:40:13 1.20
--- libmarshal.tex 2001/10/20 04:24:09 1.21
***************
*** 73,79 ****
in binary mode (\code{'rb'} or \code{'r+b'}).
! \strong{Warning:} If an object containing an unsupported type was
marshalled with \function{dump()}, \function{load()} will substitute
! \code{None} for the unmarshallable type.
\end{funcdesc}
--- 73,79 ----
in binary mode (\code{'rb'} or \code{'r+b'}).
! \warning{If an object containing an unsupported type was
marshalled with \function{dump()}, \function{load()} will substitute
! \code{None} for the unmarshallable type.}
\end{funcdesc}
Index: liboperator.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liboperator.tex,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** liboperator.tex 2001/08/10 15:55:09 1.20
--- liboperator.tex 2001/10/20 04:24:09 1.21
***************
*** 221,227 ****
The \module{operator} module also defines a few predicates to test the
! type of objects. \strong{Note:} Be careful not to misinterpret the
results of these functions; only \function{isCallable()} has any
! measure of reliability with instance objects. For example:
\begin{verbatim}
--- 221,227 ----
The \module{operator} module also defines a few predicates to test the
! type of objects. \note{Be careful not to misinterpret the
results of these functions; only \function{isCallable()} has any
! measure of reliability with instance objects. For example:}
\begin{verbatim}
***************
*** 246,253 ****
Returns true if the object \var{o} supports the mapping interface.
This is true for dictionaries and all instance objects.
! \strong{Warning:} There is no reliable way to test if an instance
supports the complete mapping protocol since the interface itself is
ill-defined. This makes this test less useful than it otherwise might
! be.
\end{funcdesc}
--- 246,253 ----
Returns true if the object \var{o} supports the mapping interface.
This is true for dictionaries and all instance objects.
! \warning{There is no reliable way to test if an instance
supports the complete mapping protocol since the interface itself is
ill-defined. This makes this test less useful than it otherwise might
! be.}
\end{funcdesc}
***************
*** 255,262 ****
Returns true if the object \var{o} represents a number. This is true
for all numeric types implemented in C, and for all instance objects.
! \strong{Warning:} There is no reliable way to test if an instance
supports the complete numeric interface since the interface itself is
ill-defined. This makes this test less useful than it otherwise might
! be.
\end{funcdesc}
--- 255,262 ----
Returns true if the object \var{o} represents a number. This is true
for all numeric types implemented in C, and for all instance objects.
! \warning{There is no reliable way to test if an instance
supports the complete numeric interface since the interface itself is
ill-defined. This makes this test less useful than it otherwise might
! be.}
\end{funcdesc}
***************
*** 264,271 ****
Returns true if the object \var{o} supports the sequence protocol.
This returns true for all objects which define sequence methods in C,
! and for all instance objects. \strong{Warning:} There is no reliable
way to test if an instance supports the complete sequence interface
since the interface itself is ill-defined. This makes this test less
! useful than it otherwise might be.
\end{funcdesc}
--- 264,271 ----
Returns true if the object \var{o} supports the sequence protocol.
This returns true for all objects which define sequence methods in C,
! and for all instance objects. \warning{There is no reliable
way to test if an instance supports the complete sequence interface
since the interface itself is ill-defined. This makes this test less
! useful than it otherwise might be.}
\end{funcdesc}
Index: libpanel.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libpanel.tex,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** libpanel.tex 2001/07/14 02:50:55 1.11
--- libpanel.tex 2001/10/20 04:24:09 1.12
***************
*** 26,35 ****
\end{funcdesc}
! \strong{Warning:}
! the Python interpreter will dump core if you don't create a GL window
! before calling
\code{panel.mkpanel()}
or
! \code{panel.defpanellist()}.
\section{\module{panelparser} ---
--- 26,34 ----
\end{funcdesc}
! \warning{The Python interpreter will dump core if you don't create a
! GL window before calling
\code{panel.mkpanel()}
or
! \code{panel.defpanellist()}.}
\section{\module{panelparser} ---
***************
*** 70,77 ****
\code{pnl.dopanel()}.
! \strong{Warning:}
! the Python interpreter will dump core if you don't create a GL window
! before calling
! \code{pnl.mkpanel()}.
The module is too large to document here in its entirety.
--- 69,74 ----
\code{pnl.dopanel()}.
! \warning{The Python interpreter will dump core if you don't create a
! GL window before calling \code{pnl.mkpanel()}.}
The module is too large to document here in its entirety.
Index: libpickle.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libpickle.tex,v
retrieving revision 1.29
retrieving revision 1.30
diff -C2 -d -r1.29 -r1.30
*** libpickle.tex 2001/09/25 16:29:17 1.29
--- libpickle.tex 2001/10/20 04:24:09 1.30
***************
*** 31,35 ****
! \strong{Note:} The \module{pickle} module is rather slow. A
reimplementation of the same algorithm in C, which is up to 1000 times
faster, is available as the
--- 31,35 ----
! \note{The \module{pickle} module is rather slow. A
reimplementation of the same algorithm in C, which is up to 1000 times
faster, is available as the
***************
*** 37,41 ****
interface except that \class{Pickler} and \class{Unpickler} are
factory functions, not classes (so they cannot be used as base classes
! for inheritance).
Although the \module{pickle} module can use the built-in module
--- 37,41 ----
interface except that \class{Pickler} and \class{Unpickler} are
factory functions, not classes (so they cannot be used as base classes
! for inheritance).}
Although the \module{pickle} module can use the built-in module
***************
*** 111,119 ****
When a pickled class instance is unpickled, its \method{__init__()} method
! is normally \emph{not} invoked. \strong{Note:} This is a deviation
from previous versions of this module; the change was introduced in
! Python 1.5b2. The reason for the change is that in many cases it is
desirable to have a constructor that requires arguments; it is a
! (minor) nuisance to have to provide a \method{__getinitargs__()} method.
If it is desirable that the \method{__init__()} method be called on
--- 111,119 ----
When a pickled class instance is unpickled, its \method{__init__()} method
! is normally \emph{not} invoked. \note{This is a deviation
from previous versions of this module; the change was introduced in
! Python 1.5. The reason for the change is that in many cases it is
desirable to have a constructor that requires arguments; it is a
! (minor) nuisance to have to provide a \method{__getinitargs__()} method.}
If it is desirable that the \method{__init__()} method be called on
Index: libposix.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libposix.tex,v
retrieving revision 1.58
retrieving revision 1.59
diff -C2 -d -r1.58 -r1.59
*** libposix.tex 2001/06/22 16:01:20 1.58
--- libposix.tex 2001/10/20 04:24:09 1.59
***************
*** 86,94 ****
\function{popen()}.
! \strong{Note:} The \refmodule{os} module provides an alternate
implementation of \code{environ} which updates the environment on
modification. Note also that updating \code{os.environ} will render
this dictionary obsolete. Use of the \refmodule{os} for this is
! recommended over direct access to the \module{posix} module.
\end{datadesc}
--- 86,94 ----
\function{popen()}.
! \note{The \refmodule{os} module provides an alternate
implementation of \code{environ} which updates the environment on
modification. Note also that updating \code{os.environ} will render
this dictionary obsolete. Use of the \refmodule{os} for this is
! recommended over direct access to the \module{posix} module.}
\end{datadesc}
Index: libposixfile.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libposixfile.tex,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -d -r1.23 -r1.24
*** libposixfile.tex 1999/04/21 21:15:35 1.23
--- libposixfile.tex 2001/10/20 04:24:09 1.24
***************
*** 12,19 ****
\indexii{\POSIX{}}{file object}
! \strong{Note:} This module will become obsolete in a future release.
The locking operation that it provides is done better and more
portably by the \function{fcntl.lockf()} call.%
! \withsubitem{(in module fcntl)}{\ttindex{lockf()}}
This module implements some additional functionality over the built-in
--- 12,19 ----
\indexii{\POSIX{}}{file object}
! \note{This module will become obsolete in a future release.
The locking operation that it provides is done better and more
portably by the \function{fcntl.lockf()} call.%
! \withsubitem{(in module fcntl)}{\ttindex{lockf()}}}
This module implements some additional functionality over the built-in
Index: libposixpath.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libposixpath.tex,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** libposixpath.tex 2001/09/28 16:14:18 1.20
--- libposixpath.tex 2001/10/20 04:24:09 1.21
***************
*** 8,14 ****
\index{path!operations}
! \strong{Warning:} On Windows, many of these functions do not properly
support UNC pathnames. \function{splitunc()} and \function{ismount()}
! do handle them correctly.
--- 8,14 ----
\index{path!operations}
! \warning{On Windows, many of these functions do not properly
support UNC pathnames. \function{splitunc()} and \function{ismount()}
! do handle them correctly.}
Index: libpwd.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libpwd.tex,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** libpwd.tex 2000/04/03 20:13:54 1.12
--- libpwd.tex 2001/10/20 04:24:09 1.13
***************
*** 25,29 ****
\exception{KeyError} is raised if the entry asked for cannot be found.
! \strong{Note:} In traditional \UNIX{} the field \code{pw_passwd} usually
contains a password encrypted with a DES derived algorithm (see module
\refmodule{crypt}\refbimodindex{crypt}). However most modern unices
--- 25,29 ----
\exception{KeyError} is raised if the entry asked for cannot be found.
! \note{In traditional \UNIX{} the field \code{pw_passwd} usually
contains a password encrypted with a DES derived algorithm (see module
\refmodule{crypt}\refbimodindex{crypt}). However most modern unices
***************
*** 31,35 ****
field \code{pw_passwd} only contains a asterisk (\code{'*'}) or the
letter \character{x} where the encrypted password is stored in a file
! \file{/etc/shadow} which is not world readable.
It defines the following items:
--- 31,35 ----
field \code{pw_passwd} only contains a asterisk (\code{'*'}) or the
letter \character{x} where the encrypted password is stored in a file
! \file{/etc/shadow} which is not world readable.}
It defines the following items:
Index: libre.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libre.tex,v
retrieving revision 1.68
retrieving revision 1.69
diff -C2 -d -r1.68 -r1.69
*** libre.tex 2001/10/05 20:06:47 1.68
--- libre.tex 2001/10/20 04:24:09 1.69
***************
*** 483,488 ****
match.
! \strong{Note:} If you want to locate a match anywhere in
! \var{string}, use \method{search()} instead.
\end{funcdesc}
--- 483,488 ----
match.
! \note{If you want to locate a match anywhere in
! \var{string}, use \method{search()} instead.}
\end{funcdesc}
***************
*** 619,624 ****
match.
! \strong{Note:} If you want to locate a match anywhere in
! \var{string}, use \method{search()} instead.
The optional second parameter \var{pos} gives an index in the string
--- 619,624 ----
match.
! \note{If you want to locate a match anywhere in
! \var{string}, use \method{search()} instead.}
The optional second parameter \var{pos} gives an index in the string
Index: librexec.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/librexec.tex,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -d -r1.17 -r1.18
*** librexec.tex 2001/07/14 02:50:55 1.17
--- librexec.tex 2001/10/20 04:24:09 1.18
***************
*** 16,23 ****
can subclass \class{RExec} to add or remove capabilities as desired.
! \emph{Note:} The \class{RExec} class can prevent code from performing
unsafe operations like reading or writing disk files, or using TCP/IP
sockets. However, it does not protect against code using extremely
! large amounts of memory or processor time.
\begin{classdesc}{RExec}{\optional{hooks\optional{, verbose}}}
--- 16,23 ----
can subclass \class{RExec} to add or remove capabilities as desired.
! \note{The \class{RExec} class can prevent code from performing
unsafe operations like reading or writing disk files, or using TCP/IP
sockets. However, it does not protect against code using extremely
! large amounts of memory or processor time.}
\begin{classdesc}{RExec}{\optional{hooks\optional{, verbose}}}
Index: libselect.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libselect.tex,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** libselect.tex 2001/07/11 18:48:39 1.18
--- libselect.tex 2001/10/20 04:24:09 1.19
***************
*** 59,66 ****
an appropriate \method{fileno()} method (that really returns a file
descriptor, not just a random integer).
! \strong{Note:}\index{WinSock} File objects on Windows are not
! acceptable, but sockets are. On Windows, the underlying
! \cfunction{select()} function is provided by the WinSock library, and
! does not handle file desciptors that don't originate from WinSock.
\end{funcdesc}
--- 59,66 ----
an appropriate \method{fileno()} method (that really returns a file
descriptor, not just a random integer).
! \note{File objects on Windows are not acceptable, but sockets
! are.\index{WinSock} On Windows, the underlying \cfunction{select()}
! function is provided by the WinSock library, and does not handle file
! desciptors that don't originate from WinSock.}
\end{funcdesc}
Index: libsmtplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsmtplib.tex,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** libsmtplib.tex 2001/09/14 17:48:41 1.20
--- libsmtplib.tex 2001/10/20 04:24:09 1.21
***************
*** 100,109 ****
Connect to a host on a given port. The defaults are to connect to the
local host at the standard SMTP port (25).
-
If the hostname ends with a colon (\character{:}) followed by a
number, that suffix will be stripped off and the number interpreted as
the port number to use.
!
! Note: This method is automatically invoked by the constructor if a
host is specified during instantiation.
\end{methoddesc}
--- 100,107 ----
Connect to a host on a given port. The defaults are to connect to the
local host at the standard SMTP port (25).
If the hostname ends with a colon (\character{:}) followed by a
number, that suffix will be stripped off and the number interpreted as
the port number to use.
! This method is automatically invoked by the constructor if a
host is specified during instantiation.
\end{methoddesc}
***************
*** 158,162 ****
an SMTP error code of 400 or greater and an error string.
! Note: many sites disable SMTP \samp{VRFY} in order to foil spammers.
\end{methoddesc}
--- 156,160 ----
an SMTP error code of 400 or greater and an error string.
! \note{Many sites disable SMTP \samp{VRFY} in order to foil spammers.}
\end{methoddesc}
***************
*** 200,206 ****
\method{data} to send the message.)
! \strong{Note:} The \var{from_addr} and \var{to_addrs} parameters are
used to construct the message envelope used by the transport agents.
! The \class{SMTP} does not modify the message headers in any way.
If there has been no previous \samp{EHLO} or \samp{HELO} command this
--- 198,204 ----
\method{data} to send the message.)
! \note{The \var{from_addr} and \var{to_addrs} parameters are
used to construct the message envelope used by the transport agents.
! The \class{SMTP} does not modify the message headers in any way.}
If there has been no previous \samp{EHLO} or \samp{HELO} command this
Index: libsocket.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsocket.tex,v
retrieving revision 1.56
retrieving revision 1.57
diff -C2 -d -r1.56 -r1.57
*** libsocket.tex 2001/10/19 17:22:29 1.56
--- libsocket.tex 2001/10/20 04:24:09 1.57
***************
*** 272,276 ****
success, a new \class{SSLObject} is returned.
! \strong{Warning:} This does not do any certificate verification!
\end{funcdesc}
--- 272,276 ----
success, a new \class{SSLObject} is returned.
! \warning{This does not do any certificate verification!}
\end{funcdesc}
***************
*** 374,381 ****
Bind the socket to \var{address}. The socket must not already be bound.
(The format of \var{address} depends on the address family --- see
! above.) \strong{Note:} This method has historically accepted a pair
of parameters for \constant{AF_INET} addresses instead of only a
tuple. This was never intentional and is no longer be available in
! Python 2.0.
\end{methoddesc}
--- 374,381 ----
Bind the socket to \var{address}. The socket must not already be bound.
(The format of \var{address} depends on the address family --- see
! above.) \note{This method has historically accepted a pair
of parameters for \constant{AF_INET} addresses instead of only a
tuple. This was never intentional and is no longer be available in
! Python 2.0.}
\end{methoddesc}
***************
*** 389,396 ****
Connect to a remote socket at \var{address}.
(The format of \var{address} depends on the address family --- see
! above.) \strong{Note:} This method has historically accepted a pair
of parameters for \constant{AF_INET} addresses instead of only a
tuple. This was never intentional and is no longer available in
! Python 2.0 and later.
\end{methoddesc}
--- 389,396 ----
Connect to a remote socket at \var{address}.
(The format of \var{address} depends on the address family --- see
! above.) \note{This method has historically accepted a pair
of parameters for \constant{AF_INET} addresses instead of only a
tuple. This was never intentional and is no longer available in
! Python 2.0 and later.}
\end{methoddesc}
***************
*** 402,409 ****
operation succeeded, otherwise the value of the \cdata{errno}
variable. This is useful, e.g., for asynchronous connects.
! \strong{Note:} This method has historically accepted a pair of
parameters for \constant{AF_INET} addresses instead of only a tuple.
This was never intentional and is no longer be available in Python
! 2.0 and later.
\end{methoddesc}
--- 402,409 ----
operation succeeded, otherwise the value of the \cdata{errno}
variable. This is useful, e.g., for asynchronous connects.
! \note{This method has historically accepted a pair of
parameters for \constant{AF_INET} addresses instead of only a tuple.
This was never intentional and is no longer be available in Python
! 2.0 and later.}
\end{methoddesc}
Index: libstdtypes.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libstdtypes.tex,v
retrieving revision 1.71
retrieving revision 1.72
diff -C2 -d -r1.71 -r1.72
*** libstdtypes.tex 2001/09/29 01:08:19 1.71
--- libstdtypes.tex 2001/10/20 04:24:09 1.72
***************
*** 1216,1221 ****
\begin{methoddesc}[file]{isatty}{}
Return true if the file is connected to a tty(-like) device, else
! false. \strong{Note:} If a file-like object is not associated
! with a real file, this method should \emph{not} be implemented.
\end{methoddesc}
--- 1216,1221 ----
\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
! with a real file, this method should \emph{not} be implemented.}
\end{methoddesc}
***************
*** 1228,1234 ****
interfaces that use file descriptors, such as the
\refmodule{fcntl}\refbimodindex{fcntl} module or
! \function{os.read()} and friends. \strong{Note:} File-like objects
which do not have a real file descriptor should \emph{not} provide
! this method!
\end{methoddesc}
--- 1228,1234 ----
interfaces that use file descriptors, such as the
\refmodule{fcntl}\refbimodindex{fcntl} module or
! \function{os.read()} and friends. \note{File-like objects
which do not have a real file descriptor should \emph{not} provide
! this method!}
\end{methoddesc}
***************
*** 1259,1265 ****
newline) and an incomplete line may be returned.
An empty string is returned when \EOF{} is hit
! immediately. Note: Unlike \code{stdio}'s \cfunction{fgets()}, the
returned string contains null characters (\code{'\e 0'}) if they
! occurred in the input.
\end{methoddesc}
--- 1259,1265 ----
newline) and an incomplete line may be returned.
An empty string is returned when \EOF{} is hit
! immediately. \note{Unlike \code{stdio}'s \cfunction{fgets()}, the
returned string contains null characters (\code{'\e 0'}) if they
! occurred in the input.}
\end{methoddesc}
***************
*** 1308,1312 ****
\begin{methoddesc}[file]{write}{str}
! Write a string to the file. There is no return value. Note: Due to
buffering, the string may not actually show up in the file until
the \method{flush()} or \method{close()} method is called.
--- 1308,1312 ----
\begin{methoddesc}[file]{write}{str}
! Write a string to the file. There is no return value. Due to
buffering, the string may not actually show up in the file until
the \method{flush()} or \method{close()} method is called.
***************
*** 1360,1366 ****
implemented in C will have to provide a writable
\member{softspace} attribute.
! \strong{Note:} This attribute is not used to control the
\keyword{print} statement, but to allow the implementation of
! \keyword{print} to keep track of its internal state.
\end{memberdesc}
--- 1360,1366 ----
implemented in C will have to provide a writable
\member{softspace} attribute.
! \note{This attribute is not used to control the
\keyword{print} statement, but to allow the implementation of
! \keyword{print} to keep track of its internal state.}
\end{memberdesc}
Index: libstdwin.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libstdwin.tex,v
retrieving revision 1.24
retrieving revision 1.25
diff -C2 -d -r1.24 -r1.25
*** libstdwin.tex 2001/07/14 02:50:55 1.24
--- libstdwin.tex 2001/10/20 04:24:09 1.25
***************
*** 5,9 ****
on the Macintosh. See CWI report CS-R8817.
! \strong{Warning:} Using STDWIN is not recommended for new
applications. It has never been ported to Microsoft Windows or
Windows NT, and for X11 or the Macintosh it lacks important
--- 5,9 ----
on the Macintosh. See CWI report CS-R8817.
! \warning{Using STDWIN is not recommended for new
applications. It has never been ported to Microsoft Windows or
Windows NT, and for X11 or the Macintosh it lacks important
***************
*** 13,17 ****
\UNIX{} under X11, native Xt with Motif or Athena widgets for \UNIX{}
under X11, Win32 for Windows and Windows NT, and a collection of
! native toolkit interfaces for the Macintosh.
--- 13,17 ----
\UNIX{} under X11, native Xt with Motif or Athena widgets for \UNIX{}
under X11, Win32 for Windows and Windows NT, and a collection of
! native toolkit interfaces for the Macintosh.}
***************
*** 176,181 ****
Note: normally, menus are created locally; see the window method
\method{menucreate()} below.
! \strong{Warning:} the menu only appears in a window as long as the object
! returned by this call exists.
\end{funcdesc}
--- 176,181 ----
Note: normally, menus are created locally; see the window method
\method{menucreate()} below.
! \warning{The menu only appears in a window as long as the object
! returned by this call exists.}
\end{funcdesc}
***************
*** 338,343 ****
only in this window).
Methods of menu objects are described below.
! \strong{Warning:} the menu only appears as long as the object
! returned by this call exists.
\end{methoddesc}
--- 338,343 ----
only in this window).
Methods of menu objects are described below.
! \warning{The menu only appears as long as the object
! returned by this call exists.}
\end{methoddesc}
Index: libstring.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libstring.tex,v
retrieving revision 1.44
retrieving revision 1.45
diff -C2 -d -r1.44 -r1.45
*** libstring.tex 2001/07/20 18:38:26 1.44
--- libstring.tex 2001/10/20 04:24:09 1.45
***************
*** 101,109 ****
\function{float()}\bifuncindex{float} when passed a string.
! \strong{Note:} When passing in a string, values for NaN\index{NaN}
and Infinity\index{Infinity} may be returned, depending on the
underlying C library. The specific set of strings accepted which
cause these values to be returned depends entirely on the C library
! and is known to vary.
\end{funcdesc}
--- 101,109 ----
\function{float()}\bifuncindex{float} when passed a string.
! \note{When passing in a string, values for NaN\index{NaN}
and Infinity\index{Infinity} may be returned, depending on the
underlying C library. The specific set of strings accepted which
cause these values to be returned depends entirely on the C library
! and is known to vary.}
\end{funcdesc}
***************
*** 195,202 ****
in \var{to}; \var{from} and \var{to} must have the same length.
! \strong{Warning:} don't use strings derived from \constant{lowercase}
and \constant{uppercase} as arguments; in some locales, these don't have
the same length. For case conversions, always use
! \function{lower()} and \function{upper()}.
\end{funcdesc}
--- 195,202 ----
in \var{to}; \var{from} and \var{to} must have the same length.
! \warning{Don't use strings derived from \constant{lowercase}
and \constant{uppercase} as arguments; in some locales, these don't have
the same length. For case conversions, always use
! \function{lower()} and \function{upper()}.}
\end{funcdesc}
Index: libsys.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsys.tex,v
retrieving revision 1.53
retrieving revision 1.54
diff -C2 -d -r1.53 -r1.54
*** libsys.tex 2001/10/16 14:54:22 1.53
--- libsys.tex 2001/10/20 04:24:09 1.54
***************
*** 100,104 ****
originally occurred. \obindex{traceback}
! \strong{Warning:} assigning the \var{traceback} return value to a
local variable in a function that is handling an exception will
cause a circular reference. This will prevent anything referenced
--- 100,104 ----
originally occurred. \obindex{traceback}
! \warning{Assigning the \var{traceback} return value to a
local variable in a function that is handling an exception will
cause a circular reference. This will prevent anything referenced
***************
*** 110,114 ****
to delete it after use (best done with a \keyword{try}
... \keyword{finally} statement) or to call \function{exc_info()} in
! a function that does not itself handle an exception.
\end{funcdesc}
--- 110,114 ----
to delete it after use (best done with a \keyword{try}
... \keyword{finally} statement) or to call \function{exc_info()} in
! a function that does not itself handle an exception.}
\end{funcdesc}
***************
*** 170,176 ****
function may be installed in this way; to allow multiple functions
which will be called at termination, use the \refmodule{atexit}
! module. Note: the exit function is not called when the program is
killed by a signal, when a Python fatal internal error is detected,
! or when \code{os._exit()} is called.
\end{datadesc}
--- 170,176 ----
function may be installed in this way; to allow multiple functions
which will be called at termination, use the \refmodule{atexit}
! module. \note{The exit function is not called when the program is
killed by a signal, when a Python fatal internal error is detected,
! or when \code{os._exit()} is called.}
\end{datadesc}
Index: libtabnanny.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libtabnanny.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** libtabnanny.tex 2000/02/23 15:44:08 1.1
--- libtabnanny.tex 2001/10/20 04:24:09 1.2
***************
*** 15,20 ****
\function{check()} described below.
! \strong{Warning:} The API provided by this module is likely to change
! in future releases; such changes may not be backward compatible.
\begin{funcdesc}{check}{file_or_dir}
--- 15,20 ----
\function{check()} described below.
! \warning{The API provided by this module is likely to change
! in future releases; such changes may not be backward compatible.}
\begin{funcdesc}{check}{file_or_dir}
Index: libtime.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libtime.tex,v
retrieving revision 1.45
retrieving revision 1.46
diff -C2 -d -r1.45 -r1.46
*** libtime.tex 2001/08/22 12:44:27 1.45
--- libtime.tex 2001/10/20 04:24:09 1.46
***************
*** 121,126 ****
or \function{localtime()} to a 24-character string of the following form:
\code{'Sun Jun 20 23:21:05 1993'}. If \var{tuple} is not provided, the
! current time as returned by \function{localtime()} is used. Note: unlike
! the C function of the same name, there is no trailing newline.
\versionchanged[Allowed \var{tuple} to be omitted]{2.1}
\end{funcdesc}
--- 121,127 ----
or \function{localtime()} to a 24-character string of the following form:
\code{'Sun Jun 20 23:21:05 1993'}. If \var{tuple} is not provided, the
! current time as returned by \function{localtime()} is used.
! \note{Unlike the C function of the same name, there is no trailing
! newline.}
\versionchanged[Allowed \var{tuple} to be omitted]{2.1}
\end{funcdesc}
***************
*** 277,284 ****
does not provide sufficient information to constrain the result.
! \strong{Note:} This function relies entirely on the underlying
platform's C library for the date parsing, and some of these libraries
are buggy. There's nothing to be done about this short of a new,
! portable implementation of \cfunction{strptime()}.
Availability: Most modern \UNIX{} systems.
--- 278,285 ----
does not provide sufficient information to constrain the result.
! \note{This function relies entirely on the underlying
platform's C library for the date parsing, and some of these libraries
are buggy. There's nothing to be done about this short of a new,
! portable implementation of \cfunction{strptime()}.}
Availability: Most modern \UNIX{} systems.
Index: libunittest.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libunittest.tex,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** libunittest.tex 2001/09/06 15:51:56 1.6
--- libunittest.tex 2001/10/20 04:24:09 1.7
***************
*** 346,352 ****
\end{verbatim}
! \strong{Note:} PyUnit supports the use of \exception{AssertionError}
as an indicator of test failure, but does not recommend it. Future
! versions may treat \exception{AssertionError} differently.
--- 346,352 ----
\end{verbatim}
! \note{PyUnit supports the use of \exception{AssertionError}
as an indicator of test failure, but does not recommend it. Future
! versions may treat \exception{AssertionError} differently.}
***************
*** 709,718 ****
method defined for the class.
! \strong{Warning:} While using a hierarchy of
\class{Testcase}-derived classes can be convenient in sharing
fixtures and helper functions, defining test methods on base classes
that are not intended to be instantiated directly does not play well
with this method. Doing so, however, can be useful when the
! fixtures are different and defined in subclasses.
\end{methoddesc}
--- 709,718 ----
method defined for the class.
! \warning{While using a hierarchy of
\class{Testcase}-derived classes can be convenient in sharing
fixtures and helper functions, defining test methods on base classes
that are not intended to be instantiated directly does not play well
with this method. Doing so, however, can be useful when the
! fixtures are different and defined in subclasses.}
\end{methoddesc}
Index: liburllib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liburllib.tex,v
retrieving revision 1.39
retrieving revision 1.40
diff -C2 -d -r1.39 -r1.40
*** liburllib.tex 2001/08/23 13:38:15 1.39
--- liburllib.tex 2001/10/20 04:24:09 1.40
***************
*** 214,223 ****
\class{URLopener}.
! \strong{Note:} When performing basic authentication, a
\class{FancyURLopener} instance calls its
\method{prompt_user_passwd()} method. The default implementation asks
the users for the required information on the controlling terminal. A
subclass may override this method to support more appropriate behavior
! if needed.
\end{classdesc}
--- 214,223 ----
\class{URLopener}.
! \note{When performing basic authentication, a
\class{FancyURLopener} instance calls its
\method{prompt_user_passwd()} method. The default implementation asks
the users for the required information on the controlling terminal. A
subclass may override this method to support more appropriate behavior
! if needed.}
\end{classdesc}
Index: liburllib2.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/liburllib2.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** liburllib2.tex 2001/07/05 21:14:03 1.4
--- liburllib2.tex 2001/10/20 04:24:09 1.5
***************
*** 392,397 ****
\subsection{HTTPRedirectHandler Objects \label{http-redirect-handler}}
! \strong{Note:} 303 redirection is not supported by this version of
! \module{urllib2}.
\begin{methoddesc}[HTTPRedirectHandler]{http_error_301}{req,
--- 392,397 ----
\subsection{HTTPRedirectHandler Objects \label{http-redirect-handler}}
! \note{303 redirection is not supported by this version of
! \module{urllib2}.}
\begin{methoddesc}[HTTPRedirectHandler]{http_error_301}{req,
Index: libwhrandom.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libwhrandom.tex,v
retrieving revision 1.14
retrieving revision 1.15
diff -C2 -d -r1.14 -r1.15
*** libwhrandom.tex 2001/02/03 01:12:44 1.14
--- libwhrandom.tex 2001/10/20 04:24:09 1.15
***************
*** 7,14 ****
\deprecated{2.1}{Use \refmodule{random} instead.}
! \strong{Note:} This module was an implementation detail of the
\refmodule{random} module in releases of Python prior to 2.1. It is
no longer used. Please do not use this module directly; use
! \refmodule{random} instead.
This module implements a Wichmann-Hill pseudo-random number generator
--- 7,14 ----
\deprecated{2.1}{Use \refmodule{random} instead.}
! \note{This module was an implementation detail of the
\refmodule{random} module in releases of Python prior to 2.1. It is
no longer used. Please do not use this module directly; use
! \refmodule{random} instead.}
This module implements a Wichmann-Hill pseudo-random number generator
Index: libwinsound.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libwinsound.tex,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** libwinsound.tex 2001/02/23 19:10:41 1.11
--- libwinsound.tex 2001/10/20 04:24:09 1.12
***************
*** 22,29 ****
sound should last. If the system is not
able to beep the speaker, \exception{RuntimeError} is raised.
! \strong{Note:} Under Windows 95 and 98, the Windows \cfunction{Beep()}
function exists but is useless (it ignores its arguments). In that
case Python simulates it via direct port manipulation (added in version
! 2.1). It's unknown whether that will work on all systems.
\versionadded{1.6}
\end{funcdesc}
--- 22,29 ----
sound should last. If the system is not
able to beep the speaker, \exception{RuntimeError} is raised.
! \note{Under Windows 95 and 98, the Windows \cfunction{Beep()}
function exists but is useless (it ignores its arguments). In that
case Python simulates it via direct port manipulation (added in version
! 2.1). It's unknown whether that will work on all systems.}
\versionadded{1.6}
\end{funcdesc}
***************
*** 86,92 ****
image of a WAV file, as a string.
! \strong{Note:} This module does not support playing from a memory
image asynchronously, so a combination of this flag and
! \constant{SND_ASYNC} will raise \exception{RuntimeError}.
\end{datadesc}
--- 86,92 ----
image of a WAV file, as a string.
! \note{This module does not support playing from a memory
image asynchronously, so a combination of this flag and
! \constant{SND_ASYNC} will raise \exception{RuntimeError}.}
\end{datadesc}
Index: xmldom.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/xmldom.tex,v
retrieving revision 1.14
retrieving revision 1.15
diff -C2 -d -r1.14 -r1.15
*** xmldom.tex 2001/06/23 16:23:47 1.14
--- xmldom.tex 2001/10/20 04:24:09 1.15
***************
*** 275,283 ****
same node).
! \strong{Note:} This is based on a proposed DOM Level 3 API which is
still in the ``working draft'' stage, but this particular interface
appears uncontroversial. Changes from the W3C will not necessarily
affect this method in the Python DOM interface (though any new W3C
! API for this would also be supported).
\end{methoddesc}
--- 275,283 ----
same node).
! \note{This is based on a proposed DOM Level 3 API which is
still in the ``working draft'' stage, but this particular interface
appears uncontroversial. Changes from the W3C will not necessarily
affect this method in the Python DOM interface (though any new W3C
! API for this would also be supported).}
\end{methoddesc}
***************
*** 620,629 ****
\end{memberdesc}
! \strong{Note:} The use of a \class{CDATASection} node does not
indicate that the node represents a complete CDATA marked section,
only that the content of the node was part of a CDATA section. A
single CDATA section may be represented by more than one node in the
document tree. There is no way to determine whether two adjacent
! \class{CDATASection} nodes represent different CDATA marked sections.
--- 620,629 ----
\end{memberdesc}
! \note{The use of a \class{CDATASection} node does not
indicate that the node represents a complete CDATA marked section,
only that the content of the node was part of a CDATA section. A
single CDATA section may be represented by more than one node in the
document tree. There is no way to determine whether two adjacent
! \class{CDATASection} nodes represent different CDATA marked sections.}
Index: xmlsaxhandler.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/xmlsaxhandler.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** xmlsaxhandler.tex 2000/12/19 04:07:54 1.4
--- xmlsaxhandler.tex 2001/10/20 04:24:09 1.5
***************
*** 264,268 ****
\code{expat} reader module produces always Unicode strings.
! \strong{Note:} The earlier SAX 1 interface provided by the Python
XML Special Interest Group used a more Java-like interface for this
method. Since most parsers used from Python did not take advantage
--- 264,268 ----
\code{expat} reader module produces always Unicode strings.
! \note{The earlier SAX 1 interface provided by the Python
XML Special Interest Group used a more Java-like interface for this
method. Since most parsers used from Python did not take advantage
***************
*** 270,274 ****
it. To convert old code to the new interface, use \var{content}
instead of slicing content with the old \var{offset} and
! \var{length} parameters.
\end{methoddesc}
--- 270,274 ----
it. To convert old code to the new interface, use \var{content}
instead of slicing content with the old \var{offset} and
! \var{length} parameters.}
\end{methoddesc}
- Previous message: [Python-checkins] CVS: python/dist/src/Doc/ref ref3.tex,1.75,1.76 ref7.tex,1.28,1.29
- Next message: [Python-checkins] CVS: python/dist/src Makefile.pre.in,1.64,1.65 configure,1.266,1.267 configure.in,1.274,1.275
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]