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 e3bb51a..062f1f2 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 39981ca..674c51f 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 0c5bb15..2eeefb0 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -27,10 +27,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 269d856..3253a07 100644
--- a/Doc/library/fileinput.rst
+++ b/Doc/library/fileinput.rst
@@ -150,7 +150,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 078cfad..9eaffab 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -364,7 +364,7 @@
If both dictionaries are omitted, the expression is executed in the environment
where :func:`execfile` is called. The return value is ``None``.
- .. warning::
+ .. note::
The default *locals* act as described for function :func:`locals` below:
modifications to the default *locals* dictionary should not be attempted. Pass
@@ -633,7 +633,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.
@@ -1363,7 +1363,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/httplib.rst b/Doc/library/httplib.rst
index 874fd54..e48c95c 100644
--- a/Doc/library/httplib.rst
+++ b/Doc/library/httplib.rst
@@ -68,9 +68,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.
.. versionadded:: 2.0
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 5af020e..bea12c9 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -510,7 +510,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 750fb2e..0366d77 100644
--- a/Doc/library/locale.rst
+++ b/Doc/library/locale.rst
@@ -398,7 +398,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.
@@ -434,7 +434,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 a9d6ea8..84fb138 100644
--- a/Doc/library/marshal.rst
+++ b/Doc/library/marshal.rst
@@ -85,7 +85,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 0e7f376..2075468 100644
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -10,7 +10,7 @@
write files see :func:`open`, and for accessing the filesystem see the
:mod:`os` module.
-.. warning::
+.. note::
On Windows, many of these functions do not properly support UNC pathnames.
:func:`splitunc` and :func:`ismount` do handle them correctly.
@@ -317,7 +317,7 @@
identify them with ``os.path.islink(file)`` and ``os.path.isdir(file)``, and
invoke :func:`walk` as necessary.
- .. warning::
+ .. note::
This function is deprecated and has been removed in 3.0 in favor of
:func:`os.walk`.
diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index f6b7ae4..a3e5ad4 100644
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -77,8 +77,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
@@ -453,7 +453,7 @@
:meth:`__getstate__` and :meth:`__setstate__`, the state object needn't be a
dictionary and these methods can do what they want. [#]_
- .. warning::
+ .. note::
For :term:`new-style class`\es, if :meth:`__getstate__` returns a false
value, the :meth:`__setstate__` method will not be called.
diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index 6ca0873..d17ac7a 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -599,7 +599,7 @@
map each character in *from* into the character at the same position in *to*;
*from* and *to* must have the same length.
- .. warning::
+ .. note::
Don't use strings derived from :const:`lowercase` and :const:`uppercase` as
arguments; in some locales, these don't have the same length. For case
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 685e941..c95566b 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -301,10 +301,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 875f3aa..b86971d 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 50314cd..6b19c29 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -1086,7 +1086,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