Merged revisions 72009 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r72009 | georg.brandl | 2009-04-27 17:29:09 +0200 (Mo, 27 Apr 2009) | 3 lines
Demote warnings to notices where appropriate, following the goal that as few "red box" warnings
should clutter the docs as possible. Part 1: stuff that gets merged to Py3k.
........
diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst
index 7011f92..90284af 100644
--- a/Doc/library/2to3.rst
+++ b/Doc/library/2to3.rst
@@ -354,7 +354,7 @@
.. moduleauthor:: Collin Winter
-.. warning::
+.. note::
The :mod:`lib2to3` API should be considered unstable and may change
drastically in the future.
diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst
index 182b121..710b14d 100644
--- a/Doc/library/aifc.rst
+++ b/Doc/library/aifc.rst
@@ -1,4 +1,3 @@
-
:mod:`aifc` --- Read and write AIFF and AIFC files
==================================================
@@ -16,10 +15,11 @@
samples in a file. AIFF-C is a newer version of the format that includes the
ability to compress the audio data.
-.. warning::
+.. note::
Some operations may only work under IRIX; these will raise :exc:`ImportError`
- when attempting to import the :mod:`cl` module, which is only available on IRIX.
+ when attempting to import the :mod:`cl` module, which is only available on
+ IRIX.
Audio files have a number of parameters that describe the audio data. The
sampling rate or frame rate is the number of times per second the sound is
diff --git a/Doc/library/codeop.rst b/Doc/library/codeop.rst
index 2c066ef..fb2f326 100644
--- a/Doc/library/codeop.rst
+++ b/Doc/library/codeop.rst
@@ -42,7 +42,7 @@
(``'single'``, the default) or as an :term:`expression` (``'eval'``). Any
other value will cause :exc:`ValueError` to be raised.
- .. warning::
+ .. note::
It is possible (but not likely) that the parser stops parsing with a
successful outcome before reaching the end of the source; in this case,
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 0c8ff65..6f840b9 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -21,10 +21,10 @@
can use this to write Python programs which can be customized by end users
easily.
-.. warning::
+.. note::
- This library does *not* interpret or write the value-type prefixes used in the
- Windows Registry extended version of INI syntax.
+ This library does *not* interpret or write the value-type prefixes used in
+ the Windows Registry extended version of INI syntax.
The configuration file consists of sections, led by a ``[section]`` header and
followed by ``name: value`` entries, with continuations in the style of
diff --git a/Doc/library/fileinput.rst b/Doc/library/fileinput.rst
index 889fdff..76d5d6f 100644
--- a/Doc/library/fileinput.rst
+++ b/Doc/library/fileinput.rst
@@ -144,7 +144,7 @@
it is deleted when the output file is closed. In-place filtering is disabled
when standard input is read.
-.. warning::
+.. note::
The current implementation does not work for MS-DOS 8+3 filesystems.
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 8c0a6ce..c79a8c4 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -359,7 +359,7 @@
global and local dictionary, respectively, which may be useful to pass around
for use as the second and third argument to :func:`exec`.
- .. warning::
+ .. note::
The default *locals* act as described for function :func:`locals` below:
modifications to the default *locals* dictionary should not be attempted.
@@ -591,7 +591,7 @@
Update and return a dictionary representing the current local symbol table.
- .. warning::
+ .. note::
The contents of this dictionary should not be modified; changes may not affect
the values of local variables used by the interpreter.
@@ -1166,7 +1166,7 @@
else that has a :attr:`__dict__` attribute), returns a dictionary corresponding
to the object's symbol table.
- .. warning::
+ .. note::
The returned dictionary should not be modified:
the effects on the corresponding symbol table are undefined. [#]_
diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst
index 919b0bf..8ecd7c7 100644
--- a/Doc/library/http.client.rst
+++ b/Doc/library/http.client.rst
@@ -52,9 +52,9 @@
formatted file that contains your private key. *cert_file* is a PEM formatted
certificate chain file.
- .. warning::
+ .. note::
- This does not do any certificate verification!
+ This does not do any certificate verification.
.. class:: HTTPResponse(sock[, debuglevel=0][, strict=0])
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 253c303..f002994 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -455,7 +455,7 @@
the function name, a list of lines of context from the source code, and the
index of the current line within that list.
-.. warning::
+.. note::
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
diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst
index da3a843..f72a44a 100644
--- a/Doc/library/locale.rst
+++ b/Doc/library/locale.rst
@@ -377,7 +377,7 @@
Return name of the n-th day of the week.
- .. warning::
+ .. note::
This follows the US convention of :const:`DAY_1` being Sunday, not the
international convention (ISO 8601) that Monday is the first day of the week.
@@ -413,7 +413,7 @@
Return a regular expression that can be used with the regex function to
recognize a positive response to a yes/no question.
- .. warning::
+ .. note::
The expression is in the syntax suitable for the :cfunc:`regex` function from
the C library, which might differ from the syntax used in :mod:`re`.
diff --git a/Doc/library/marshal.rst b/Doc/library/marshal.rst
index 8ef443f..9a2e95d 100644
--- a/Doc/library/marshal.rst
+++ b/Doc/library/marshal.rst
@@ -73,7 +73,7 @@
file must be an open file object opened in binary mode (``'rb'`` or
``'r+b'``).
- .. warning::
+ .. note::
If an object containing an unsupported type was marshalled with :func:`dump`,
:func:`load` will substitute ``None`` for the unmarshallable type.
diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst
index d04fd09..99d106b 100644
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -23,12 +23,11 @@
their parameters. The result is an object of the same type, if a path or
file name is returned.
-.. warning::
+.. note::
On Windows, many of these functions do not properly support UNC pathnames.
:func:`splitunc` and :func:`ismount` do handle them correctly.
-
.. note::
Since different operating systems have different path name conventions, there
@@ -288,6 +287,33 @@
*unc* will always be the empty string. Availability: Windows.
+<<<<<<< .working
+=======
+.. function:: walk(path, visit, arg)
+
+ Calls the function *visit* with arguments ``(arg, dirname, names)`` for each
+ directory in the directory tree rooted at *path* (including *path* itself, if it
+ is a directory). The argument *dirname* specifies the visited directory, the
+ argument *names* lists the files in the directory (gotten from
+ ``os.listdir(dirname)``). The *visit* function may modify *names* to influence
+ the set of directories visited below *dirname*, e.g. to avoid visiting certain
+ parts of the tree. (The object referred to by *names* must be modified in
+ place, using :keyword:`del` or slice assignment.)
+
+ .. note::
+
+ Symbolic links to directories are not treated as subdirectories, and that
+ :func:`walk` therefore will not visit them. To visit linked directories you must
+ identify them with ``os.path.islink(file)`` and ``os.path.isdir(file)``, and
+ invoke :func:`walk` as necessary.
+
+ .. note::
+
+ This function is deprecated and has been removed in 3.0 in favor of
+ :func:`os.walk`.
+
+
+>>>>>>> .merge-right.r72009
.. data:: supports_unicode_filenames
True if arbitrary Unicode strings can be used as file names (within limitations
diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index bb0da80..1c70196 100644
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -66,8 +66,8 @@
.. warning::
The :mod:`pickle` module is not intended to be secure against erroneous or
- maliciously constructed data. Never unpickle data received from an untrusted or
- unauthenticated source.
+ maliciously constructed data. Never unpickle data received from an untrusted
+ or unauthenticated source.
Note that serialization is a more primitive notion than persistence; although
:mod:`pickle` reads and writes file objects, it does not handle the issue of
@@ -437,6 +437,7 @@
the methods :meth:`__getstate__` and :meth:`__setstate__`.
.. note::
+
At unpickling time, some methods like :meth:`__getattr__`,
:meth:`__getattribute__`, or :meth:`__setattr__` may be called upon the
instance. In case those methods rely on some internal invariant being
diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index 517e209..52bd8f1 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -1,4 +1,3 @@
-
:mod:`string` --- Common string operations
==========================================
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index ed9a762..3b6c8cc 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -321,10 +321,10 @@
.. warning::
- Use :meth:`communicate` rather than :meth:`.stdin.write`,
- :meth:`.stdout.read` or :meth:`.stderr.read` to avoid deadlocks due
- to any of the other OS pipe buffers filling up and blocking the child
- process.
+ Use :meth:`communicate` rather than :attr:`.stdin.write <stdin>`,
+ :attr:`.stdout.read <stdout>` or :attr:`.stderr.read <stderr>` to avoid
+ deadlocks due to any of the other OS pipe buffers filling up and blocking the
+ child process.
.. attribute:: Popen.stdin
diff --git a/Doc/library/tabnanny.rst b/Doc/library/tabnanny.rst
index f43659f..c5d8236 100644
--- a/Doc/library/tabnanny.rst
+++ b/Doc/library/tabnanny.rst
@@ -1,4 +1,3 @@
-
:mod:`tabnanny` --- Detection of ambiguous indentation
======================================================
@@ -14,9 +13,9 @@
is possible to import it into an IDE and use the function :func:`check`
described below.
-.. warning::
+.. note::
- The API provided by this module is likely to change in future releases; such
+ The API provided by this module is likely to change in future releases; such
changes may not be backward compatible.
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 4ecf476..f40dba0 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -1085,7 +1085,7 @@
creates an instance of the class for each test method defined for the
class.
- .. warning::
+ .. note::
While using a hierarchy of :class:`TestCase`\ -derived classes can be
convenient in sharing fixtures and helper functions, defining test