Merged revisions 84142 via svnmerge from

birkenfeld · birkenfeld · commit 23b4f927d5e1 · 2010-10-06T08:43:56.000Z
svn+ssh://svn.python.org/python/branches/py3k

........
  r84142 | georg.brandl | 2010-08-17 17:07:14 +0200 (Di, 17 Aug 2010) | 1 line

  Consistency check for versionadded/changed directives.
........
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst
@@ -320,13 +320,14 @@ Other objects
    the conversion has failed.  When the conversion fails, the *converter* function
    should raise an exception and leave the content of *address* unmodified.
 
-   If the *converter* returns Py_CLEANUP_SUPPORTED, it may get called a second time
-   if the argument parsing eventually fails, giving the converter a chance to release
-   any memory that it had already allocated. In this second call, the *object* parameter
-   will be NULL; *address* will have the same value as in the original call.
+   If the *converter* returns ``Py_CLEANUP_SUPPORTED``, it may get called a
+   second time if the argument parsing eventually fails, giving the converter a
+   chance to release any memory that it had already allocated. In this second
+   call, the *object* parameter will be NULL; *address* will have the same value
+   as in the original call.
 
    .. versionchanged:: 3.1
-      Py_CLEANUP_SUPPORTED was added.
+      ``Py_CLEANUP_SUPPORTED`` was added.
 
 ``(items)`` (:class:`tuple`) [*matching-items*]
    The object must be a Python sequence whose length is the number of format units
diff --git a/Doc/c-api/long.rst b/Doc/c-api/long.rst
@@ -165,6 +165,7 @@ All integers are implemented as "long" integer objects of arbitrary size.
    cannot be represented as a :ctype:`long long`, an
    :exc:`OverflowError` is raised and ``-1`` is returned.
 
+
 .. cfunction:: unsigned PY_LONG_LONG PyLong_AsUnsignedLongLong(PyObject *pylong)
 
    .. index::
@@ -176,8 +177,8 @@ All integers are implemented as "long" integer objects of arbitrary size.
    returned.
 
    .. versionchanged:: 3.1
-      A negative *pylong* now raises :exc:`OverflowError`, not
-      :exc:`TypeError`.
+      A negative *pylong* now raises :exc:`OverflowError`, not :exc:`TypeError`.
+
 
 .. cfunction:: unsigned long PyLong_AsUnsignedLongMask(PyObject *io)
 
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
@@ -369,6 +369,7 @@ used, passsing :func:`PyUnicode_FSConverter` as the conversion function:
 
    .. versionadded:: 3.1
 
+
 .. cfunction:: PyObject* PyUnicode_DecodeFSDefaultAndSize(const char *s, Py_ssize_t size)
 
    Decode a null-terminated string using :cdata:`Py_FileSystemDefaultEncoding`
diff --git a/Doc/distutils/sourcedist.rst b/Doc/distutils/sourcedist.rst
@@ -206,6 +206,6 @@ distribution::
 :option:`-o` is a shortcut for :option:`--manifest-only`.
 
 .. versionchanged:: 3.1
-    An existing generated :file:`MANIFEST` will be regenerated without
-    :command:`sdist` comparing its modification time to the one of
-    :file:`MANIFEST.in` or :file:`setup.py`.
+   An existing generated :file:`MANIFEST` will be regenerated without
+   :command:`sdist` comparing its modification time to the one of
+   :file:`MANIFEST.in` or :file:`setup.py`.
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
@@ -552,7 +552,7 @@ they add the ability to access fields by name instead of position index.
    lightweight and require no more memory than regular tuples.
 
    .. versionchanged:: 3.1
-      added support for *rename*.
+      Added support for *rename*.
 
 Example:
 
@@ -843,7 +843,6 @@ attribute.
       class.
 
 
-
 :class:`UserList` objects
 -------------------------
 
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
@@ -38,14 +38,14 @@ The :mod:`dis` module defines the following functions and constants:
 
 .. function:: dis(x=None)
 
-   Disassemble the *x* object.  *x* can denote either a module, a
-   class, a method, a function, a code object, a string of source code or a
-   byte sequence of raw bytecode.  For a module, it disassembles all
-   functions.  For a class, it disassembles all methods.  For a code object
-   or sequence of raw bytecode, it prints one line per bytecode instruction.
-   Strings are first compiled to code objects with the :func:`compile`
-   built-in function before being disassembled.  If no object is provided,
-   this function disassembles the last traceback.
+   Disassemble the *x* object.  *x* can denote either a module, a class, a
+   method, a function, a code object, a string of source code or a byte sequence
+   of raw bytecode.  For a module, it disassembles all functions.  For a class,
+   it disassembles all methods.  For a code object or sequence of raw bytecode,
+   it prints one line per bytecode instruction.  Strings are first compiled to
+   code objects with the :func:`compile` built-in function before being
+   disassembled.  If no object is provided, this function disassembles the last
+   traceback.
 
 
 .. function:: distb(tb=None)
diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
@@ -105,10 +105,9 @@ A hash object has the following methods:
    equivalent to ``m.update(a+b)``.
 
    .. versionchanged:: 3.1
-
-      The Python GIL is released to allow other threads to run while
-      hash updates on data larger than 2048 bytes is taking place when
-      using hash algorithms supplied by OpenSSL.
+      The Python GIL is released to allow other threads to run while hash
+      updates on data larger than 2048 bytes is taking place when using hash
+      algorithms supplied by OpenSSL.
 
 
 .. method:: hash.digest()
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
@@ -299,7 +299,7 @@ I/O Base Classes
       Return the new absolute position.
 
       .. versionadded:: 3.1
-         The ``SEEK_*`` constants
+         The ``SEEK_*`` constants.
 
    .. method:: seekable()
 
diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
@@ -207,6 +207,7 @@ loops that truncate the stream.
 
    .. versionadded:: 3.1
 
+
 .. function:: compress(data, selectors)
 
    Make an iterator that filters elements from *data* returning only those that
@@ -240,7 +241,7 @@ loops that truncate the stream.
    for i in count())``.
 
    .. versionchanged:: 3.1
-      added *step* argument and allowed non-integer arguments.
+      Added *step* argument and allowed non-integer arguments.
 
 .. function:: cycle(iterable)
 
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
@@ -895,6 +895,7 @@ instantiated directly, but always through the module-level function
    :const:`NOTSET` is found, and that value is returned.
 
 
+
 .. method:: Logger.debug(msg, *args, **kwargs)
 
    Logs a message with level :const:`DEBUG` on this logger. The *msg* is the
@@ -2638,6 +2639,9 @@ methods of :class:`Logger`, i.e. :meth:`debug`, :meth:`info`, :meth:`warning`,
 methods have the same signatures as their counterparts in :class:`Logger`, so
 you can use the two types of instances interchangeably.
 
+   The :meth:`isEnabledFor` method was added to :class:`LoggerAdapter`.  This
+   method delegates to the underlying logger.
+
 
 Thread Safety
 -------------
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
@@ -67,23 +67,22 @@ Notes on the availability of these functions:
 File Names, Command Line Arguments, and Environment Variables
 -------------------------------------------------------------
 
-In Python, file names, command line arguments, and environment
-variables are represented using the string type. On some systems,
-decoding these strings to and from bytes is necessary before passing
-them to the operating system. Python uses the file system encoding to
-perform this conversion (see :func:`sys.getfilesystemencoding`).
+In Python, file names, command line arguments, and environment variables are
+represented using the string type. On some systems, decoding these strings to
+and from bytes is necessary before passing them to the operating system. Python
+uses the file system encoding to perform this conversion (see
+:func:`sys.getfilesystemencoding`).
 
 .. versionchanged:: 3.1
-   On some systems, conversion using the file system encoding may
-   fail. In this case, Python uses the ``surrogateescape`` encoding
-   error handler, which means that undecodable bytes are replaced by a
-   Unicode character U+DCxx on decoding, and these are again
-   translated to the original byte on encoding.
+   On some systems, conversion using the file system encoding may fail. In this
+   case, Python uses the ``surrogateescape`` encoding error handler, which means
+   that undecodable bytes are replaced by a Unicode character U+DCxx on
+   decoding, and these are again translated to the original byte on encoding.
 
 
-The file system encoding must guarantee to successfully decode all
-bytes below 128. If the file system encoding fails to provide this
-guarantee, API functions may raise UnicodeErrors.
+The file system encoding must guarantee to successfully decode all bytes
+below 128. If the file system encoding fails to provide this guarantee, API
+functions may raise UnicodeErrors.
 
 
 .. _os-procinfo:
diff --git a/Doc/library/runpy.rst b/Doc/library/runpy.rst
@@ -67,9 +67,8 @@ The :mod:`runpy` module provides a single function:
    It is recommended that the :mod:`sys` module be left alone when invoking this
    function from threaded code.
 
-
    .. versionchanged:: 3.1
-         Added ability to execute packages by looking for a ``__main__`` submodule
+      Added ability to execute packages by looking for a ``__main__`` submodule.
 
 
 .. seealso::
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
@@ -234,7 +234,6 @@ Connection Objects
    supplied, this must be a custom cursor class that extends
    :class:`sqlite3.Cursor`.
 
-
 .. method:: Connection.commit()
 
    This method commits the current transaction. If you don't call this method,
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
@@ -829,6 +829,9 @@ functions based on regular expressions.
    :func:`codecs.register_error`, see section :ref:`codec-base-classes`. For a
    list of possible encodings, see section :ref:`standard-encodings`.
 
+   .. versionchanged:: 3.1
+      Support for keyword arguments added.
+
 
 .. method:: str.endswith(suffix[, start[, end]])
 
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
@@ -873,7 +873,7 @@ always available.
    and so on.
 
    .. versionchanged:: 3.1
-      Added named component attributes
+      Added named component attributes.
 
 .. data:: warnoptions
 
diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst
@@ -346,7 +346,7 @@ The :mod:`urllib.parse` module defines the following functions:
    parameters are sent the :func:`quote_plus` for encoding.
 
    .. versionchanged:: 3.2
-      query paramater supports bytes and string.
+      Query parameter supports bytes and string objects.
 
 
 .. seealso::
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
@@ -66,6 +66,7 @@ The module defines the following items:
    .. versionchanged:: 3.1
       Support for file and file-like objects.
 
+
 .. data:: ZIP_STORED
 
    The numeric constant for an uncompressed archive member.
diff --git a/Doc/library/zipimport.rst b/Doc/library/zipimport.rst
@@ -93,7 +93,7 @@ zipimporter Objects
       was imported. Raise :exc:`ZipImportError` if the module couldn't be
       found.
 
-   .. versionadded:: 3.1
+      .. versionadded:: 3.1
 
 
    .. method:: get_source(fullname)
