]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298)
authorSerhiy Storchaka <storchaka@gmail.com>
Thu, 7 Mar 2024 08:05:03 +0000 (10:05 +0200)
committerGitHub <noreply@github.com>
Thu, 7 Mar 2024 08:05:03 +0000 (10:05 +0200)
22 files changed:
Doc/c-api/contextvars.rst
Doc/c-api/import.rst
Doc/c-api/init.rst
Doc/c-api/refcounting.rst
Doc/library/asyncio-eventloop.rst
Doc/library/bz2.rst
Doc/library/collections.rst
Doc/library/faulthandler.rst
Doc/library/functools.rst
Doc/library/hashlib.rst
Doc/library/importlib.metadata.rst
Doc/library/os.rst
Doc/library/pdb.rst
Doc/library/stat.rst
Doc/library/stdtypes.rst
Doc/library/threading.rst
Doc/library/time.rst
Doc/library/turtle.rst
Doc/library/urllib.request.rst
Doc/reference/lexical_analysis.rst
Doc/reference/simple_stmts.rst
Doc/using/cmdline.rst

index d970f5443b1df5770b75005e0b86f74bef9e6173..fe7b8f93f2c6cf7a4ea95c8d15474b19aa019a0d 100644 (file)
@@ -6,6 +6,8 @@ Context Variables Objects
 -------------------------
 
 .. _contextvarsobjects_pointertype_change:
+.. versionadded:: 3.7
+
 .. versionchanged:: 3.7.1
 
    .. note::
@@ -24,8 +26,6 @@ Context Variables Objects
       See :issue:`34762` for more details.
 
 
-.. versionadded:: 3.7
-
 This section details the public C API for the :mod:`contextvars` module.
 
 .. c:type:: PyContext
index 7c74e9e88678dc0c93cb4e140992bca9896f27d6..1054b38cb92f7d015de907861ee80e02aeb575ae 100644 (file)
@@ -308,7 +308,7 @@ Importing Modules
 
       The module name, as an ASCII encoded string.
 
-   .. c: member:: PyObject* (*initfunc)(void)
+   .. c:member:: PyObject* (*initfunc)(void)
 
       Initialization function for a module built into the interpreter.
 
index e7199ad5e0c1b15a5272f4b52e74ad50512b9c92..05f2fd13cf2069bf13727bd69898da5017e49471 100644 (file)
@@ -1575,14 +1575,14 @@ pointer and a void pointer argument.
       function is generally **not** suitable for calling Python code from
       arbitrary C threads.  Instead, use the :ref:`PyGILState API<gilstate>`.
 
+   .. versionadded:: 3.1
+
    .. versionchanged:: 3.9
       If this function is called in a subinterpreter, the function *func* is
       now scheduled to be called from the subinterpreter, rather than being
       called from the main interpreter. Each subinterpreter now has its own
       list of scheduled calls.
 
-   .. versionadded:: 3.1
-
 .. _profiling:
 
 Profiling and Tracing
index 75e1d46474f1e75062244d618ae8d097c60d2d7c..bf50107347e0e7893aa269a18e6a3d31aab37eff 100644 (file)
@@ -23,12 +23,12 @@ of Python objects.
 
    Use the :c:func:`Py_SET_REFCNT()` function to set an object reference count.
 
-   .. versionchanged:: 3.11
-      The parameter type is no longer :c:expr:`const PyObject*`.
-
    .. versionchanged:: 3.10
       :c:func:`Py_REFCNT()` is changed to the inline static function.
 
+   .. versionchanged:: 3.11
+      The parameter type is no longer :c:expr:`const PyObject*`.
+
 
 .. c:function:: void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt)
 
index be4d04e2d8cb898577f84e6caebe5f67c6285059..06c5c877ccc173e31d329817286c63b1f2ae453d 100644 (file)
@@ -605,6 +605,9 @@ Opening network connections
       The *family*, *proto*, *flags*, *reuse_address*, *reuse_port*,
       *allow_broadcast*, and *sock* parameters were added.
 
+   .. versionchanged:: 3.8
+      Added support for Windows.
+
    .. versionchanged:: 3.8.1
       The *reuse_address* parameter is no longer supported, as using
       :ref:`socket.SO_REUSEADDR <socket-unix-constants>`
@@ -622,9 +625,6 @@ Opening network connections
       prevents processes with differing UIDs from assigning sockets to the same
       socket address.
 
-   .. versionchanged:: 3.8
-      Added support for Windows.
-
    .. versionchanged:: 3.11
       The *reuse_address* parameter, disabled since Python 3.8.1,
       3.7.6 and 3.6.10, has been entirely removed.
index 6a95a4a6e8d18321bdb043f8d32e7436b0cfb19d..5e0aa3e493f22491b43fc7bc4864bf648feaa8ce 100644 (file)
@@ -156,7 +156,6 @@ The :mod:`bz2` module contains:
       Support was added for *filename* being a :term:`file object` instead of an
       actual filename.
 
-   .. versionchanged:: 3.3
       The ``'a'`` (append) mode was added, along with support for reading
       multi-stream files.
 
index c246173c1bbf53bc9a8bf55f992228f3013b2f08..f868799e7f5c1058d30153afca09f027772921bc 100644 (file)
@@ -343,7 +343,7 @@ superset relationships: ``==``, ``!=``, ``<``, ``<=``, ``>``, ``>=``.
 All of those tests treat missing elements as having zero counts so that
 ``Counter(a=1) == Counter(a=1, b=0)`` returns true.
 
-.. versionadded:: 3.10
+.. versionchanged:: 3.10
    Rich comparison operations were added.
 
 .. versionchanged:: 3.10
index f64dfeb5e081c7c33fc86f3303cd84ae99314466..96593ee97a139d9e5f8a3b40b8be076a765decff 100644 (file)
@@ -118,12 +118,12 @@ Dumping the tracebacks after a timeout
 
    This function is implemented using a watchdog thread.
 
-   .. versionchanged:: 3.7
-      This function is now always available.
-
    .. versionchanged:: 3.5
       Added support for passing file descriptor to this function.
 
+   .. versionchanged:: 3.7
+      This function is now always available.
+
 .. function:: cancel_dump_traceback_later()
 
    Cancel the last call to :func:`dump_traceback_later`.
index 20fcbe76c36985e7e89e4bb5091945caed5f7a02..82c970d25a7aac3d82706afb308acaa500befe4b 100644 (file)
@@ -667,13 +667,9 @@ The :mod:`functools` module defines the following functions:
    on the wrapper function). :exc:`AttributeError` is still raised if the
    wrapper function itself is missing any attributes named in *updated*.
 
-   .. versionadded:: 3.2
-      Automatic addition of the ``__wrapped__`` attribute.
-
-   .. versionadded:: 3.2
-      Copying of the ``__annotations__`` attribute by default.
-
    .. versionchanged:: 3.2
+      The ``__wrapped__`` attribute is now automatically added.
+      The ``__annotations__`` attribute is now copied by default.
       Missing attributes no longer trigger an :exc:`AttributeError`.
 
    .. versionchanged:: 3.4
index 0726be4590e39948d2f0b37e218837b640213348..aa0c6fc503e8ff2dff92bff143359f70308e04a3 100644 (file)
@@ -77,8 +77,6 @@ accessible by name via :func:`new`.  See :data:`algorithms_available`.
    SHA3 (Keccak) and SHAKE constructors :func:`sha3_224`, :func:`sha3_256`,
    :func:`sha3_384`, :func:`sha3_512`, :func:`shake_128`, :func:`shake_256`
    were added.
-
-.. versionadded:: 3.6
    :func:`blake2b` and :func:`blake2s` were added.
 
 .. _hashlib-usedforsecurity:
index cc4a0da92da60a9e34c090030fab5dcc0a28813e..f4fb7791855307bea72f3b8eead68acb084efa0f 100644 (file)
@@ -219,7 +219,6 @@ all the metadata in a JSON-compatible form per :PEP:`566`::
    The ``Description`` is now included in the metadata when presented
    through the payload. Line continuation characters have been removed.
 
-.. versionadded:: 3.10
    The ``json`` attribute was added.
 
 
index cc9f3e75a80c5176fcd176f6493a9aa3f8db1422..09d8228f986e4774913bb9eec2149a8726622283 100644 (file)
@@ -2614,7 +2614,6 @@ features:
    .. versionchanged:: 3.8
       Accepts a :term:`path-like object` and a bytes object on Windows.
 
-   .. versionchanged:: 3.8
       Added support for directory junctions, and changed to return the
       substitution path (which typically includes ``\\?\`` prefix) rather
       than the optional "print name" field that was previously returned.
@@ -3115,21 +3114,21 @@ features:
 
       Time of most recent access expressed in nanoseconds as an integer.
 
-      .. versionadded: 3.3
+      .. versionadded:: 3.3
 
    .. attribute:: st_mtime_ns
 
       Time of most recent content modification expressed in nanoseconds as an
       integer.
 
-      .. versionadded: 3.3
+      .. versionadded:: 3.3
 
    .. attribute:: st_ctime_ns
 
       Time of most recent metadata change expressed in nanoseconds as an
       integer.
 
-      .. versionadded: 3.3
+      .. versionadded:: 3.3
 
       .. versionchanged:: 3.12
          ``st_ctime_ns`` is deprecated on Windows. Use ``st_birthtime_ns``
@@ -3257,10 +3256,10 @@ features:
       Windows now returns the file index as :attr:`st_ino` when
       available.
 
-   .. versionadded:: 3.7
+   .. versionchanged:: 3.7
       Added the :attr:`st_fstype` member to Solaris/derivatives.
 
-   .. versionadded:: 3.8
+   .. versionchanged:: 3.8
       Added the :attr:`st_reparse_tag` member on Windows.
 
    .. versionchanged:: 3.8
@@ -3274,16 +3273,13 @@ features:
       platforms, but for now still contains creation time.
       Use :attr:`st_birthtime` for the creation time.
 
-   .. versionchanged:: 3.12
       On Windows, :attr:`st_ino` may now be up to 128 bits, depending
       on the file system. Previously it would not be above 64 bits, and
       larger file identifiers would be arbitrarily packed.
 
-   .. versionchanged:: 3.12
       On Windows, :attr:`st_rdev` no longer returns a value. Previously
       it would contain the same as :attr:`st_dev`, which was incorrect.
 
-   .. versionadded:: 3.12
       Added the :attr:`st_birthtime` member on Windows.
 
 
@@ -4496,15 +4492,15 @@ written in Python, such as a mail server's external command delivery program.
       On macOS the use of this function is unsafe when mixed with using
       higher-level system APIs, and that includes using :mod:`urllib.request`.
 
+   .. versionchanged:: 3.8
+      Calling ``forkpty()`` in a subinterpreter is no longer supported
+      (:exc:`RuntimeError` is raised).
+
    .. versionchanged:: 3.12
       If Python is able to detect that your process has multiple
       threads, this now raises a :exc:`DeprecationWarning`. See the
       longer explanation on :func:`os.fork`.
 
-   .. versionchanged:: 3.8
-      Calling ``forkpty()`` in a subinterpreter is no longer supported
-      (:exc:`RuntimeError` is raised).
-
    .. availability:: Unix, not Emscripten, not WASI.
 
 
@@ -4719,8 +4715,6 @@ written in Python, such as a mail server's external command delivery program.
 
    .. versionchanged:: 3.13
       *env* parameter accepts ``None``.
-
-   .. versionchanged:: 3.13
       ``os.POSIX_SPAWN_CLOSEFROM`` is available on platforms where
       :c:func:`!posix_spawn_file_actions_addclosefrom_np` exists.
 
@@ -5708,20 +5702,20 @@ Random numbers
       easy-to-use interface to the random number generator provided by your
       platform, please see :class:`random.SystemRandom`.
 
-   .. versionchanged:: 3.6.0
-      On Linux, ``getrandom()`` is now used in blocking mode to increase the
-      security.
-
-   .. versionchanged:: 3.5.2
-      On Linux, if the ``getrandom()`` syscall blocks (the urandom entropy pool
-      is not initialized yet), fall back on reading ``/dev/urandom``.
-
    .. versionchanged:: 3.5
       On Linux 3.17 and newer, the ``getrandom()`` syscall is now used
       when available.  On OpenBSD 5.6 and newer, the C ``getentropy()``
       function is now used. These functions avoid the usage of an internal file
       descriptor.
 
+   .. versionchanged:: 3.5.2
+      On Linux, if the ``getrandom()`` syscall blocks (the urandom entropy pool
+      is not initialized yet), fall back on reading ``/dev/urandom``.
+
+   .. versionchanged:: 3.6
+      On Linux, ``getrandom()`` is now used in blocking mode to increase the
+      security.
+
    .. versionchanged:: 3.11
       On Windows, ``BCryptGenRandom()`` is used instead of ``CryptGenRandom()``
       which is deprecated.
index cb17acfb367619cc4b91856a6a8ba9c3824e0c59..1cfca0cf68a946bf19b0fa2020270e4dda633ef2 100644 (file)
@@ -292,15 +292,15 @@ typed at the debugger prompt.  This is particularly useful for aliases.  If both
 files exist, the one in the home directory is read first and aliases defined there
 can be overridden by the local file.
 
-.. versionchanged:: 3.11
-   :file:`.pdbrc` is now read with ``'utf-8'`` encoding. Previously, it was read
-   with the system locale encoding.
-
 .. versionchanged:: 3.2
    :file:`.pdbrc` can now contain commands that continue debugging, such as
    :pdbcmd:`continue` or :pdbcmd:`next`.  Previously, these commands had no
    effect.
 
+.. versionchanged:: 3.11
+   :file:`.pdbrc` is now read with ``'utf-8'`` encoding. Previously, it was read
+   with the system locale encoding.
+
 
 .. pdbcommand:: h(elp) [command]
 
index c941d5557e31b5f1c29eacd6f6177d3ed082670a..f7a3b7b16fe5c3946116c897e8171dafca5d14f5 100644 (file)
@@ -354,7 +354,7 @@ The following flags can be used in the *flags* argument of :func:`os.chflags`:
 
    All user settable flags.
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: UF_NODUMP
 
@@ -384,13 +384,13 @@ The following flags can be used in the *flags* argument of :func:`os.chflags`:
 
    Used for handling document IDs (macOS)
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: UF_DATAVAULT
 
    The file needs an entitlement for reading or writing (macOS 10.13+)
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: UF_HIDDEN
 
@@ -400,7 +400,7 @@ The following flags can be used in the *flags* argument of :func:`os.chflags`:
 
    All super-user changeable flags
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: SF_SUPPORTED
 
@@ -408,7 +408,7 @@ The following flags can be used in the *flags* argument of :func:`os.chflags`:
 
    .. availability:: macOS
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: SF_SYNTHETIC
 
@@ -416,7 +416,7 @@ The following flags can be used in the *flags* argument of :func:`os.chflags`:
 
    .. availability:: macOS
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: SF_ARCHIVED
 
@@ -434,7 +434,7 @@ The following flags can be used in the *flags* argument of :func:`os.chflags`:
 
    The file needs an entitlement to write to (macOS 10.13+)
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: SF_NOUNLINK
 
@@ -448,13 +448,13 @@ The following flags can be used in the *flags* argument of :func:`os.chflags`:
 
    The file is a firmlink (macOS 10.15+)
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 .. data:: SF_DATALESS
 
    The file is a dataless object (macOS 10.15+)
 
-   .. versionadded: 3.13
+   .. versionadded:: 3.13
 
 See the \*BSD or macOS systems man page :manpage:`chflags(2)` for more information.
 
index c81626a194e6400c8963b3dcc4abc9c43162d57f..c963519f164dd228f964b7a0dec668b3325e22a4 100644 (file)
@@ -1491,8 +1491,7 @@ objects that compare equal might have different :attr:`~range.start`,
    sequence of values they define (instead of comparing based on
    object identity).
 
-.. versionadded:: 3.3
-   The :attr:`~range.start`, :attr:`~range.stop` and :attr:`~range.step`
+   Added the :attr:`~range.start`, :attr:`~range.stop` and :attr:`~range.step`
    attributes.
 
 .. seealso::
index cb511471579b6940cec70a3c362f9ab8947d7508..4cf98a49e11442cfd4c14b095e62cb62e58d6ec1 100644 (file)
@@ -363,12 +363,12 @@ since it is impossible to detect the termination of alien threads.
    base class constructor (``Thread.__init__()``) before doing anything else to
    the thread.
 
+   .. versionchanged:: 3.3
+      Added the *daemon* parameter.
+
    .. versionchanged:: 3.10
       Use the *target* name if *name* argument is omitted.
 
-   .. versionchanged:: 3.3
-      Added the *daemon* argument.
-
    .. method:: start()
 
       Start the thread's activity.
index 88c15f19bedf8c8f8da8b1befe37073e372066dc..029663e0801a0dc80b136827daf6ed73adf0a7d2 100644 (file)
@@ -383,15 +383,14 @@ Functions
 
    .. audit-event:: time.sleep secs
 
-   .. versionchanged:: 3.11
-      On Unix, the ``clock_nanosleep()`` and ``nanosleep()`` functions are now
-      used if available. On Windows, a waitable timer is now used.
-
    .. versionchanged:: 3.5
       The function now sleeps at least *secs* even if the sleep is interrupted
       by a signal, except if the signal handler raises an exception (see
       :pep:`475` for the rationale).
 
+   .. versionchanged:: 3.11
+      On Unix, the ``clock_nanosleep()`` and ``nanosleep()`` functions are now
+      used if available. On Windows, a waitable timer is now used.
 
    .. versionchanged:: 3.13
       Raises an auditing event.
index 88b1f09eb3c8b785c1f0be4f1e61c55ac1c1f7c2..2941201332a715e613c35df5f80963aff21de946 100644 (file)
@@ -606,7 +606,7 @@ Turtle motion
       >>> turtle.pos()
       (20.00,30.00)
 
-   .. versionadded: 3.12
+   .. versionadded:: 3.12
 
 
 .. function:: setx(x)
index affdce144cd5fcc0c562405f012040c661c36882..1a17c9cd7dec4e56f57bb7f191198bb297fc3152 100644 (file)
@@ -97,11 +97,9 @@ The :mod:`urllib.request` module defines the following functions:
    .. versionchanged:: 3.2
       *cafile* and *capath* were added.
 
-   .. versionchanged:: 3.2
       HTTPS virtual hosts are now supported if possible (that is, if
       :const:`ssl.HAS_SNI` is true).
 
-   .. versionadded:: 3.2
       *data* can be an iterable object.
 
    .. versionchanged:: 3.3
index 0adfb0365934e4a3a054519c27e5557063d9fda4..40bd477bcaf762bfe39b4c6f12533150b7052ddd 100644 (file)
@@ -514,7 +514,6 @@ is not supported.
    The ``'rb'`` prefix of raw bytes literals has been added as a synonym
    of ``'br'``.
 
-.. versionadded:: 3.3
    Support for the unicode legacy literal (``u'value'``) was reintroduced
    to simplify the maintenance of dual Python 2.x and 3.x codebases.
    See :pep:`414` for more information.
index 04132c78ce77a6704c3a48891f5c777632e2aeaf..810232e09dc5fad1276a277432ba443c3428147a 100644 (file)
@@ -664,8 +664,7 @@ and information about handling exceptions is in section :ref:`try`.
 .. versionchanged:: 3.3
     :const:`None` is now permitted as ``Y`` in ``raise X from Y``.
 
-.. versionadded:: 3.3
-    The :attr:`~BaseException.__suppress_context__` attribute to suppress
+    Added the :attr:`~BaseException.__suppress_context__` attribute to suppress
     automatic display of the exception context.
 
 .. versionchanged:: 3.11
index 53c95ca1a05c9b47a2fe93eb50d16d2c2f04ddb4..0a7f6363a2b628d4bc313ee536ed2f7ebde5a681 100644 (file)
@@ -375,11 +375,11 @@ Miscellaneous options
    :envvar:`PYTHONHASHSEED` allows you to set a fixed value for the hash
    seed secret.
 
+   .. versionadded:: 3.2.3
+
    .. versionchanged:: 3.7
       The option is no longer ignored.
 
-   .. versionadded:: 3.2.3
-
 
 .. option:: -s
 
@@ -563,23 +563,22 @@ Miscellaneous options
    It also allows passing arbitrary values and retrieving them through the
    :data:`sys._xoptions` dictionary.
 
-   .. versionchanged:: 3.2
-      The :option:`-X` option was added.
+   .. versionadded:: 3.2
 
-   .. versionadded:: 3.3
-      The ``-X faulthandler`` option.
+   .. versionchanged:: 3.3
+      Added the ``-X faulthandler`` option.
 
-   .. versionadded:: 3.4
-      The ``-X showrefcount`` and ``-X tracemalloc`` options.
+   .. versionchanged:: 3.4
+      Added the ``-X showrefcount`` and ``-X tracemalloc`` options.
 
-   .. versionadded:: 3.6
-      The ``-X showalloccount`` option.
+   .. versionchanged:: 3.6
+      Added the ``-X showalloccount`` option.
 
-   .. versionadded:: 3.7
-      The ``-X importtime``, ``-X dev`` and ``-X utf8`` options.
+   .. versionchanged:: 3.7
+      Added the ``-X importtime``, ``-X dev`` and ``-X utf8`` options.
 
-   .. versionadded:: 3.8
-      The ``-X pycache_prefix`` option. The ``-X dev`` option now logs
+   .. versionchanged:: 3.8
+      Added the ``-X pycache_prefix`` option. The ``-X dev`` option now logs
       ``close()`` exceptions in :class:`io.IOBase` destructor.
 
    .. versionchanged:: 3.9
@@ -588,27 +587,19 @@ Miscellaneous options
 
       The ``-X showalloccount`` option has been removed.
 
-   .. versionadded:: 3.10
-      The ``-X warn_default_encoding`` option.
+   .. versionchanged:: 3.10
+      Added the ``-X warn_default_encoding`` option.
       Removed the ``-X oldparser`` option.
 
-   .. versionadded:: 3.11
-      The ``-X no_debug_ranges`` option.
-
-   .. versionadded:: 3.11
-      The ``-X frozen_modules`` option.
-
-   .. versionadded:: 3.11
-      The ``-X int_max_str_digits`` option.
-
-   .. versionadded:: 3.12
-      The ``-X perf`` option.
+   .. versionchanged:: 3.11
+      Added the ``-X no_debug_ranges``, ``-X frozen_modules`` and
+      ``-X int_max_str_digits`` options.
 
-   .. versionadded:: 3.13
-      The ``-X cpu_count`` option.
+   .. versionchanged:: 3.12
+      Added the ``-X perf`` option.
 
-   .. versionadded:: 3.13
-      The ``-X presite`` option.
+   .. versionchanged:: 3.13
+      Added the ``-X cpu_count`` and ``-X presite`` options.
 
 .. _using-on-controlling-color:
 
@@ -955,11 +946,11 @@ conflict.
    * ``pymalloc_debug``: same as ``pymalloc`` but also install debug hooks.
    * ``mimalloc_debug``: same as ``mimalloc`` but also install debug hooks.
 
+   .. versionadded:: 3.6
+
    .. versionchanged:: 3.7
       Added the ``"default"`` allocator.
 
-   .. versionadded:: 3.6
-
 
 .. envvar:: PYTHONMALLOCSTATS