From 61063cca6abe36005f6e327358d533af8a56d33c Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 24 Jun 2012 22:48:30 +0200 Subject: Fix a couple of versionadded/versionchanged related markup errors. --- Doc/c-api/arg.rst | 5 +++-- Doc/library/abc.rst | 4 ++-- Doc/library/email.errors.rst | 4 ++-- Doc/library/email.parser.rst | 3 ++- Doc/library/email.util.rst | 8 ++++++-- Doc/library/html.parser.rst | 3 ++- Doc/library/http.server.rst | 3 ++- Doc/library/importlib.rst | 4 ++-- Doc/library/mailbox.rst | 3 ++- Doc/library/os.path.rst | 3 ++- Doc/library/select.rst | 1 - Doc/library/smtplib.rst | 3 ++- Doc/library/time.rst | 13 +++++-------- Doc/library/urllib.request.rst | 9 ++++----- Doc/library/winreg.rst | 3 ++- Doc/library/xml.sax.utils.rst | 2 +- 16 files changed, 39 insertions(+), 32 deletions(-) diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index 2bcbbad..b28aa5f 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -264,7 +264,8 @@ Numbers Convert a Python byte, represented as a :class:`bytes` or :class:`bytearray` object of length 1, to a C :c:type:`char`. - .. versionchanged:: 3.3 Allow :class:`bytearray` objects + .. versionchanged:: 3.3 + Allow :class:`bytearray` objects. ``C`` (:class:`str` of length 1) [int] Convert a Python character, represented as a :class:`str` object of @@ -324,7 +325,7 @@ Other objects This accepts any valid Python value. See :ref:`truth` for more information about how Python tests values for truth. - .. versionchanged:: 3.3 + .. versionadded:: 3.3 ``(items)`` (:class:`tuple`) [*matching-items*] The object must be a Python sequence whose length is the number of format units diff --git a/Doc/library/abc.rst b/Doc/library/abc.rst index 6f42222..dca6993 100644 --- a/Doc/library/abc.rst +++ b/Doc/library/abc.rst @@ -217,7 +217,7 @@ The :mod:`abc` module also provides the following decorators: .. versionadded:: 3.2 .. deprecated:: 3.3 - Use :class:`classmethod` with :func:`abstractmethod` instead + Use :class:`classmethod` with :func:`abstractmethod` instead. .. decorator:: abstractstaticmethod(function) @@ -234,7 +234,7 @@ The :mod:`abc` module also provides the following decorators: .. versionadded:: 3.2 .. deprecated:: 3.3 - Use :class:`staticmethod` with :func:`abstractmethod` instead + Use :class:`staticmethod` with :func:`abstractmethod` instead. .. decorator:: abstractproperty(fget=None, fset=None, fdel=None, doc=None) diff --git a/Doc/library/email.errors.rst b/Doc/library/email.errors.rst index acfa6b2..9f0a9e2 100644 --- a/Doc/library/email.errors.rst +++ b/Doc/library/email.errors.rst @@ -76,7 +76,7 @@ this class is *not* an exception! * :class:`CloseBoundaryNotFoundDefect` -- A start boundary was found, but no corresponding close boundary was ever found. - .. versionadded: 3.3 + .. versionadded:: 3.3 * :class:`FirstHeaderLineIsContinuationDefect` -- The message had a continuation line as its first header line. @@ -88,7 +88,7 @@ this class is *not* an exception! headers that had no leading white space but contained no ':'. Parsing continues assuming that the line represents the first line of the body. - .. versionadded: 3.3 + .. versionadded:: 3.3 * :class:`MalformedHeaderDefect` -- A header was found that was missing a colon, or was otherwise malformed. diff --git a/Doc/library/email.parser.rst b/Doc/library/email.parser.rst index 96fe444..54e5521 100644 --- a/Doc/library/email.parser.rst +++ b/Doc/library/email.parser.rst @@ -107,7 +107,8 @@ can be much faster in these situations, since they do not attempt to parse the message body, instead setting the payload to the raw body as a string. They have the same API as the :class:`Parser` and :class:`BytesParser` classes. -.. versionadded:: 3.3 BytesHeaderParser +.. versionadded:: 3.3 + The BytesHeaderParser class. .. class:: Parser(_class=email.message.Message, *, policy=policy.default) diff --git a/Doc/library/email.util.rst b/Doc/library/email.util.rst index b05c5d2..bad0b24 100644 --- a/Doc/library/email.util.rst +++ b/Doc/library/email.util.rst @@ -41,7 +41,8 @@ There are several useful utilities provided in the :mod:`email.utils` module: characters. Can be an instance of :class:`str` or a :class:`~email.charset.Charset`. Defaults to ``utf-8``. - .. versionchanged: 3.3 added the *charset* option + .. versionchanged:: 3.3 + Added the *charset* option. .. function:: getaddresses(fieldvalues) @@ -93,6 +94,8 @@ There are several useful utilities provided in the :mod:`email.utils` module: corresponding a :class:`~datetime.timezone` :class:`~datetime.tzinfo`. .. versionadded:: 3.3 + + .. function:: mktime_tz(tuple) Turn a 10-tuple as returned by :func:`parsedate_tz` into a UTC timestamp. It @@ -164,7 +167,8 @@ There are several useful utilities provided in the :mod:`email.utils` module: may be useful certain cases, such as a constructing distributed system that uses a consistent domain name across multiple hosts. - .. versionchanged:: 3.2 domain keyword added + .. versionchanged:: 3.2 + Added the *domain* keyword. .. function:: decode_rfc2231(s) diff --git a/Doc/library/html.parser.rst b/Doc/library/html.parser.rst index 4715185..e4154ef 100644 --- a/Doc/library/html.parser.rst +++ b/Doc/library/html.parser.rst @@ -33,7 +33,8 @@ parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML. This parser does not check that end tags match start tags or call the end-tag handler for elements which are closed implicitly by closing an outer element. - .. versionchanged:: 3.2 *strict* keyword added + .. versionchanged:: 3.2 + *strict* keyword added. .. deprecated-removed:: 3.3 3.5 The *strict* argument and the strict mode have been deprecated. diff --git a/Doc/library/http.server.rst b/Doc/library/http.server.rst index 04ec746..cbad3ed 100644 --- a/Doc/library/http.server.rst +++ b/Doc/library/http.server.rst @@ -201,7 +201,8 @@ of which this module provides three different variants: specifying its value. Note that, after the send_header calls are done, :meth:`end_headers` MUST BE called in order to complete the operation. - .. versionchanged:: 3.2 Headers are stored in an internal buffer. + .. versionchanged:: 3.2 + Headers are stored in an internal buffer. .. method:: send_response_only(code, message=None) diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst index 9dc6ed1..4dc1c78 100644 --- a/Doc/library/importlib.rst +++ b/Doc/library/importlib.rst @@ -785,8 +785,8 @@ an :term:`importer`. loader should initialize as specified by :pep:`302` as best as possible. .. versionchanged:: 3.3 - :attr:`__loader__` and :attr:`__package__` are automatically set - (when possible). + :attr:`__loader__` and :attr:`__package__` are automatically set + (when possible). .. decorator:: set_loader diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst index 83a590e..8623630 100644 --- a/Doc/library/mailbox.rst +++ b/Doc/library/mailbox.rst @@ -89,7 +89,8 @@ Maildir, mbox, MH, Babyl, and MMDF. format-specific information is used. Otherwise, reasonable defaults for format-specific information are used. - .. versionchanged:: 3.2 support for binary input + .. versionchanged:: 3.2 + Support for binary input was added. .. method:: remove(key) diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst index 214e27c..7821628 100644 --- a/Doc/library/os.path.rst +++ b/Doc/library/os.path.rst @@ -254,7 +254,8 @@ applications should use string objects to access all files. Availability: Unix, Windows. - .. versionchanged:: 3.2 Added Windows support. + .. versionchanged:: 3.2 + Added Windows support. .. function:: samestat(stat1, stat2) diff --git a/Doc/library/select.rst b/Doc/library/select.rst index 0e667fe..4e60f4a 100644 --- a/Doc/library/select.rst +++ b/Doc/library/select.rst @@ -50,7 +50,6 @@ The module defines the following: .. versionchanged:: 3.3 - Added the *flags* parameter. diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 45c5d6d..711981f 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -362,7 +362,8 @@ An :class:`SMTP` instance has the following methods: Unless otherwise noted, the connection will be open even after an exception is raised. - .. versionchanged:: 3.2 *msg* may be a byte string. + .. versionchanged:: 3.2 + *msg* may be a byte string. .. method:: SMTP.send_message(msg, from_addr=None, to_addrs=None, \ diff --git a/Doc/library/time.rst b/Doc/library/time.rst index ac3fb5e..799140c 100644 --- a/Doc/library/time.rst +++ b/Doc/library/time.rst @@ -78,10 +78,9 @@ An explanation of some terminology and conventions is in order. See :class:`struct_time` for a description of these objects. .. versionchanged:: 3.3 - - The :class:`struct_time` type was extended to provide the - :attr:`tm_gmtoff` and :attr:`tm_zone` attributes when platform - supports corresponding ``struct tm`` members. + The :class:`struct_time` type was extended to provide the :attr:`tm_gmtoff` + and :attr:`tm_zone` attributes when platform supports corresponding + ``struct tm`` members. * Use the following functions to convert between time representations: @@ -558,10 +557,8 @@ The module defines the following functions and data items: :exc:`TypeError` is raised. .. versionchanged:: 3.3 - - :attr:`tm_gmtoff` and :attr:`tm_zone` attributes are avaliable on - platforms with C library supporting the corresponding fields in - ``struct tm``. + :attr:`tm_gmtoff` and :attr:`tm_zone` attributes are avaliable on platforms + with C library supporting the corresponding fields in ``struct tm``. .. function:: time() diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index cd90a80..887e737 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -212,7 +212,7 @@ The following classes are provided: :attr:`~Request.method` attribute and is used by :meth:`get_method()`. .. versionchanged:: 3.3 - :attr:`Request.method` argument is added to the Request class. + :attr:`Request.method` argument is added to the Request class. .. class:: OpenerDirector() @@ -967,10 +967,9 @@ FileHandler Objects Open the file locally, if there is no host name, or the host name is ``'localhost'``. - This method is applicable only for local hostnames. When a remote hostname - is given, an :exc:`URLError` is raised. - -.. versionchanged:: 3.2 + .. versionchanged:: 3.2 + This method is applicable only for local hostnames. When a remote + hostname is given, an :exc:`URLError` is raised. .. _ftp-handler-objects: diff --git a/Doc/library/winreg.rst b/Doc/library/winreg.rst index f7756da..a878da2 100644 --- a/Doc/library/winreg.rst +++ b/Doc/library/winreg.rst @@ -290,7 +290,8 @@ This module offers the following functions: If the function fails, :exc:`OSError` is raised. - .. versionchanged:: 3.2 Allow the use of named arguments. + .. versionchanged:: 3.2 + Allow the use of named arguments. .. versionchanged:: 3.3 This function used to raise a :exc:`WindowsError`, which is now an diff --git a/Doc/library/xml.sax.utils.rst b/Doc/library/xml.sax.utils.rst index ff36fd8..0a4038c 100644 --- a/Doc/library/xml.sax.utils.rst +++ b/Doc/library/xml.sax.utils.rst @@ -62,7 +62,7 @@ or as base classes. tags, if set to *True* they are emitted as a single self-closed tag. .. versionadded:: 3.2 - short_empty_elements + The *short_empty_elements* parameter. .. class:: XMLFilterBase(base) -- cgit v0.12