mirror of
https://github.com/python/cpython.git
synced 2025-07-25 12:14:38 +00:00
Fix a couple of versionadded/versionchanged related markup errors.
This commit is contained in:
parent
f551001322
commit
61063cca6a
16 changed files with 39 additions and 32 deletions
|
@ -264,7 +264,8 @@ Numbers
|
||||||
Convert a Python byte, represented as a :class:`bytes` or
|
Convert a Python byte, represented as a :class:`bytes` or
|
||||||
:class:`bytearray` object of length 1, to a C :c:type:`char`.
|
: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]
|
``C`` (:class:`str` of length 1) [int]
|
||||||
Convert a Python character, represented as a :class:`str` object of
|
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
|
This accepts any valid Python value. See :ref:`truth` for more
|
||||||
information about how Python tests values for truth.
|
information about how Python tests values for truth.
|
||||||
|
|
||||||
.. versionchanged:: 3.3
|
.. versionadded:: 3.3
|
||||||
|
|
||||||
``(items)`` (:class:`tuple`) [*matching-items*]
|
``(items)`` (:class:`tuple`) [*matching-items*]
|
||||||
The object must be a Python sequence whose length is the number of format units
|
The object must be a Python sequence whose length is the number of format units
|
||||||
|
|
|
@ -217,7 +217,7 @@ The :mod:`abc` module also provides the following decorators:
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
.. versionadded:: 3.2
|
||||||
.. deprecated:: 3.3
|
.. deprecated:: 3.3
|
||||||
Use :class:`classmethod` with :func:`abstractmethod` instead
|
Use :class:`classmethod` with :func:`abstractmethod` instead.
|
||||||
|
|
||||||
|
|
||||||
.. decorator:: abstractstaticmethod(function)
|
.. decorator:: abstractstaticmethod(function)
|
||||||
|
@ -234,7 +234,7 @@ The :mod:`abc` module also provides the following decorators:
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
.. versionadded:: 3.2
|
||||||
.. deprecated:: 3.3
|
.. 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)
|
.. decorator:: abstractproperty(fget=None, fset=None, fdel=None, doc=None)
|
||||||
|
|
|
@ -76,7 +76,7 @@ this class is *not* an exception!
|
||||||
* :class:`CloseBoundaryNotFoundDefect` -- A start boundary was found, but
|
* :class:`CloseBoundaryNotFoundDefect` -- A start boundary was found, but
|
||||||
no corresponding close boundary was ever found.
|
no corresponding close boundary was ever found.
|
||||||
|
|
||||||
.. versionadded: 3.3
|
.. versionadded:: 3.3
|
||||||
|
|
||||||
* :class:`FirstHeaderLineIsContinuationDefect` -- The message had a continuation
|
* :class:`FirstHeaderLineIsContinuationDefect` -- The message had a continuation
|
||||||
line as its first header line.
|
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
|
headers that had no leading white space but contained no ':'. Parsing
|
||||||
continues assuming that the line represents the first line of the body.
|
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,
|
* :class:`MalformedHeaderDefect` -- A header was found that was missing a colon,
|
||||||
or was otherwise malformed.
|
or was otherwise malformed.
|
||||||
|
|
|
@ -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
|
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.
|
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)
|
.. class:: Parser(_class=email.message.Message, *, policy=policy.default)
|
||||||
|
|
|
@ -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
|
characters. Can be an instance of :class:`str` or a
|
||||||
:class:`~email.charset.Charset`. Defaults to ``utf-8``.
|
: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)
|
.. 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`.
|
corresponding a :class:`~datetime.timezone` :class:`~datetime.tzinfo`.
|
||||||
|
|
||||||
.. versionadded:: 3.3
|
.. versionadded:: 3.3
|
||||||
|
|
||||||
|
|
||||||
.. function:: mktime_tz(tuple)
|
.. function:: mktime_tz(tuple)
|
||||||
|
|
||||||
Turn a 10-tuple as returned by :func:`parsedate_tz` into a UTC timestamp. It
|
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
|
may be useful certain cases, such as a constructing distributed system that
|
||||||
uses a consistent domain name across multiple hosts.
|
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)
|
.. function:: decode_rfc2231(s)
|
||||||
|
|
|
@ -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
|
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.
|
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
|
.. deprecated-removed:: 3.3 3.5
|
||||||
The *strict* argument and the strict mode have been deprecated.
|
The *strict* argument and the strict mode have been deprecated.
|
||||||
|
|
|
@ -201,7 +201,8 @@ of which this module provides three different variants:
|
||||||
specifying its value. Note that, after the send_header calls are done,
|
specifying its value. Note that, after the send_header calls are done,
|
||||||
:meth:`end_headers` MUST BE called in order to complete the operation.
|
: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)
|
.. method:: send_response_only(code, message=None)
|
||||||
|
|
|
@ -785,8 +785,8 @@ an :term:`importer`.
|
||||||
loader should initialize as specified by :pep:`302` as best as possible.
|
loader should initialize as specified by :pep:`302` as best as possible.
|
||||||
|
|
||||||
.. versionchanged:: 3.3
|
.. versionchanged:: 3.3
|
||||||
:attr:`__loader__` and :attr:`__package__` are automatically set
|
:attr:`__loader__` and :attr:`__package__` are automatically set
|
||||||
(when possible).
|
(when possible).
|
||||||
|
|
||||||
.. decorator:: set_loader
|
.. decorator:: set_loader
|
||||||
|
|
||||||
|
|
|
@ -89,7 +89,8 @@ Maildir, mbox, MH, Babyl, and MMDF.
|
||||||
format-specific information is used. Otherwise, reasonable defaults for
|
format-specific information is used. Otherwise, reasonable defaults for
|
||||||
format-specific information are used.
|
format-specific information are used.
|
||||||
|
|
||||||
.. versionchanged:: 3.2 support for binary input
|
.. versionchanged:: 3.2
|
||||||
|
Support for binary input was added.
|
||||||
|
|
||||||
|
|
||||||
.. method:: remove(key)
|
.. method:: remove(key)
|
||||||
|
|
|
@ -254,7 +254,8 @@ applications should use string objects to access all files.
|
||||||
|
|
||||||
Availability: Unix, Windows.
|
Availability: Unix, Windows.
|
||||||
|
|
||||||
.. versionchanged:: 3.2 Added Windows support.
|
.. versionchanged:: 3.2
|
||||||
|
Added Windows support.
|
||||||
|
|
||||||
|
|
||||||
.. function:: samestat(stat1, stat2)
|
.. function:: samestat(stat1, stat2)
|
||||||
|
|
|
@ -50,7 +50,6 @@ The module defines the following:
|
||||||
|
|
||||||
|
|
||||||
.. versionchanged:: 3.3
|
.. versionchanged:: 3.3
|
||||||
|
|
||||||
Added the *flags* parameter.
|
Added the *flags* parameter.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -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
|
Unless otherwise noted, the connection will be open even after an exception is
|
||||||
raised.
|
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, \
|
.. method:: SMTP.send_message(msg, from_addr=None, to_addrs=None, \
|
||||||
|
|
|
@ -78,10 +78,9 @@ An explanation of some terminology and conventions is in order.
|
||||||
See :class:`struct_time` for a description of these objects.
|
See :class:`struct_time` for a description of these objects.
|
||||||
|
|
||||||
.. versionchanged:: 3.3
|
.. versionchanged:: 3.3
|
||||||
|
The :class:`struct_time` type was extended to provide the :attr:`tm_gmtoff`
|
||||||
The :class:`struct_time` type was extended to provide the
|
and :attr:`tm_zone` attributes when platform supports corresponding
|
||||||
:attr:`tm_gmtoff` and :attr:`tm_zone` attributes when platform
|
``struct tm`` members.
|
||||||
supports corresponding ``struct tm`` members.
|
|
||||||
|
|
||||||
* Use the following functions to convert between time representations:
|
* 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.
|
:exc:`TypeError` is raised.
|
||||||
|
|
||||||
.. versionchanged:: 3.3
|
.. versionchanged:: 3.3
|
||||||
|
:attr:`tm_gmtoff` and :attr:`tm_zone` attributes are avaliable on platforms
|
||||||
:attr:`tm_gmtoff` and :attr:`tm_zone` attributes are avaliable on
|
with C library supporting the corresponding fields in ``struct tm``.
|
||||||
platforms with C library supporting the corresponding fields in
|
|
||||||
``struct tm``.
|
|
||||||
|
|
||||||
.. function:: time()
|
.. function:: time()
|
||||||
|
|
||||||
|
|
|
@ -212,7 +212,7 @@ The following classes are provided:
|
||||||
:attr:`~Request.method` attribute and is used by :meth:`get_method()`.
|
:attr:`~Request.method` attribute and is used by :meth:`get_method()`.
|
||||||
|
|
||||||
.. versionchanged:: 3.3
|
.. 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()
|
.. class:: OpenerDirector()
|
||||||
|
@ -967,10 +967,9 @@ FileHandler Objects
|
||||||
Open the file locally, if there is no host name, or the host name is
|
Open the file locally, if there is no host name, or the host name is
|
||||||
``'localhost'``.
|
``'localhost'``.
|
||||||
|
|
||||||
This method is applicable only for local hostnames. When a remote hostname
|
.. versionchanged:: 3.2
|
||||||
is given, an :exc:`URLError` is raised.
|
This method is applicable only for local hostnames. When a remote
|
||||||
|
hostname is given, an :exc:`URLError` is raised.
|
||||||
.. versionchanged:: 3.2
|
|
||||||
|
|
||||||
|
|
||||||
.. _ftp-handler-objects:
|
.. _ftp-handler-objects:
|
||||||
|
|
|
@ -290,7 +290,8 @@ This module offers the following functions:
|
||||||
|
|
||||||
If the function fails, :exc:`OSError` is raised.
|
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
|
.. versionchanged:: 3.3
|
||||||
This function used to raise a :exc:`WindowsError`, which is now an
|
This function used to raise a :exc:`WindowsError`, which is now an
|
||||||
|
|
|
@ -62,7 +62,7 @@ or as base classes.
|
||||||
tags, if set to *True* they are emitted as a single self-closed tag.
|
tags, if set to *True* they are emitted as a single self-closed tag.
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
.. versionadded:: 3.2
|
||||||
short_empty_elements
|
The *short_empty_elements* parameter.
|
||||||
|
|
||||||
|
|
||||||
.. class:: XMLFilterBase(base)
|
.. class:: XMLFilterBase(base)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue