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.
This commit is contained in:
parent
d91f8cf779
commit
16a57f6a34
|
@ -44,7 +44,7 @@ This implies inclusion of the following standard headers: ``<stdio.h>``,
|
|||
``<string.h>``, ``<errno.h>``, ``<limits.h>``, and ``<stdlib.h>`` (if
|
||||
available).
|
||||
|
||||
.. warning::
|
||||
.. note::
|
||||
|
||||
Since Python may define some pre-processor definitions which affect the standard
|
||||
headers on some systems, you *must* include :file:`Python.h` before any standard
|
||||
|
|
|
@ -594,11 +594,11 @@ units as well as normal text:
|
|||
|
||||
.. describe:: warning
|
||||
|
||||
An important bit of information about an API that a user should be very aware
|
||||
of when using whatever bit of API the warning pertains to. The content of
|
||||
the directive should be written in complete sentences and include all
|
||||
appropriate punctuation. This differs from ``note`` in that it is recommended
|
||||
over ``note`` for information regarding security.
|
||||
An important bit of information about an API that a user should be aware of
|
||||
when using whatever bit of API the warning pertains to. The content of the
|
||||
directive should be written in complete sentences and include all appropriate
|
||||
punctuation. This should only be chosen over ``note`` for information
|
||||
regarding the possibility of crashes, data loss, or security implications.
|
||||
|
||||
.. describe:: versionadded
|
||||
|
||||
|
|
|
@ -47,7 +47,7 @@ The first line of our file can be::
|
|||
which pulls in the Python API (you can add a comment describing the purpose of
|
||||
the module and a copyright notice if you like).
|
||||
|
||||
.. warning::
|
||||
.. note::
|
||||
|
||||
Since Python may define some pre-processor definitions which affect the standard
|
||||
headers on some systems, you *must* include :file:`Python.h` before any standard
|
||||
|
|
|
@ -354,7 +354,7 @@ and off individually. They are described here in more detail.
|
|||
.. moduleauthor:: Collin Winter
|
||||
|
||||
|
||||
.. warning::
|
||||
.. note::
|
||||
|
||||
The :mod:`lib2to3` API should be considered unstable and may change
|
||||
drastically in the future.
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
:mod:`aifc` --- Read and write AIFF and AIFC files
|
||||
==================================================
|
||||
|
||||
|
@ -16,10 +15,11 @@ AIFF is Audio Interchange File Format, a format for storing digital audio
|
|||
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
|
||||
|
|
|
@ -42,7 +42,7 @@ To do just the former:
|
|||
(``'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,
|
||||
|
|
|
@ -27,10 +27,10 @@ structure similar to what you would find on Microsoft Windows INI files. You
|
|||
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
|
||||
|
|
|
@ -150,7 +150,7 @@ and the backup file remains around; by default, the extension is ``'.bak'`` and
|
|||
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.
|
||||
|
||||
|
|
|
@ -364,7 +364,7 @@ available. They are listed here in alphabetical order.
|
|||
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 @@ available. They are listed here in alphabetical order.
|
|||
|
||||
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 @@ available. They are listed here in alphabetical order.
|
|||
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. [#]_
|
||||
|
|
|
@ -68,9 +68,9 @@ The module provides the following classes:
|
|||
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
|
||||
|
||||
|
|
|
@ -510,7 +510,7 @@ six items: the frame object, the filename, the line number of the current line,
|
|||
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
|
||||
|
|
|
@ -398,7 +398,7 @@ descriptions are taken from the corresponding description in the GNU C library.
|
|||
|
||||
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 @@ descriptions are taken from the corresponding description in the GNU C library.
|
|||
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`.
|
||||
|
|
|
@ -85,7 +85,7 @@ The module defines these functions:
|
|||
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.
|
||||
|
|
|
@ -10,7 +10,7 @@ This module implements some useful functions on pathnames. To read or
|
|||
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 @@ write files see :func:`open`, and for accessing the filesystem see the
|
|||
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`.
|
||||
|
|
|
@ -77,8 +77,8 @@ The :mod:`pickle` module differs from :mod:`marshal` several significant ways:
|
|||
.. 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 @@ Pickling and unpickling normal class instances
|
|||
: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.
|
||||
|
|
|
@ -599,7 +599,7 @@ They are not available as string methods.
|
|||
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
|
||||
|
|
|
@ -301,10 +301,10 @@ The following attributes are also available:
|
|||
|
||||
.. 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
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
:mod:`tabnanny` --- Detection of ambiguous indentation
|
||||
======================================================
|
||||
|
||||
|
@ -14,9 +13,9 @@ For the time being this module is intended to be called as a script. However it
|
|||
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.
|
||||
|
||||
|
||||
|
|
|
@ -1086,7 +1086,7 @@ Loading and running tests
|
|||
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
|
||||
|
|
|
@ -178,7 +178,7 @@ function :func:`range` returns a sequence of integers suitable to emulate the
|
|||
effect of Pascal's ``for i := a to b do``; e.g., ``range(3)`` returns the list
|
||||
``[0, 1, 2]``.
|
||||
|
||||
.. warning::
|
||||
.. note::
|
||||
|
||||
.. index::
|
||||
single: loop; over mutable sequence
|
||||
|
|
|
@ -231,7 +231,7 @@ Exceptions can also be identified by strings, in which case the
|
|||
:keyword:`except` clause is selected by object identity. An arbitrary value can
|
||||
be raised along with the identifying string which can be passed to the handler.
|
||||
|
||||
.. warning::
|
||||
.. note::
|
||||
|
||||
Messages to exceptions are not part of the Python API. Their contents may
|
||||
change from one version of Python to the next without warning and should not be
|
||||
|
|
Loading…
Reference in New Issue