Skip to content

[3.11] gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298) (GH-116450) #116452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Doc/c-api/contextvars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Context Variables Objects
-------------------------

.. _contextvarsobjects_pointertype_change:
.. versionadded:: 3.7

.. versionchanged:: 3.7.1

.. note::
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/import.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,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.

Expand Down
4 changes: 2 additions & 2 deletions Doc/c-api/init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1533,14 +1533,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
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/asyncio-eventloop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,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>`
Expand All @@ -605,9 +608,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.
Expand Down
1 change: 0 additions & 1 deletion Doc/library/bz2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/collections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,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
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/faulthandler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
8 changes: 2 additions & 6 deletions Doc/library/functools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -650,13 +650,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
Expand Down
2 changes: 0 additions & 2 deletions Doc/library/hashlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 0 additions & 1 deletion Doc/library/importlib.metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,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.


Expand Down
27 changes: 13 additions & 14 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2366,7 +2366,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.
Expand Down Expand Up @@ -2848,14 +2847,14 @@ 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

Expand All @@ -2865,7 +2864,7 @@ features:
* the time of creation on Windows, expressed in nanoseconds as an
integer.

.. versionadded: 3.3
.. versionadded:: 3.3

.. note::

Expand Down Expand Up @@ -2975,10 +2974,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
Expand Down Expand Up @@ -5121,20 +5120,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.
Expand Down
8 changes: 4 additions & 4 deletions Doc/library/pdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -273,15 +273,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]

Expand Down
3 changes: 1 addition & 2 deletions Doc/library/stdtypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1451,8 +1451,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::
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/threading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -342,12 +342,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.
Expand Down
7 changes: 3 additions & 4 deletions Doc/library/time.rst
Original file line number Diff line number Diff line change
Expand Up @@ -381,15 +381,14 @@ Functions
* Or use ``nanosleep()`` if available (resolution: 1 nanosecond);
* Or use ``select()`` (resolution: 1 microsecond).

.. 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.

.. index::
single: % (percent); datetime format
Expand Down
2 changes: 0 additions & 2 deletions Doc/library/urllib.request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,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
Expand Down
1 change: 0 additions & 1 deletion Doc/reference/lexical_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,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.
Expand Down
3 changes: 1 addition & 2 deletions Doc/reference/simple_stmts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -663,8 +663,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
Expand Down
46 changes: 20 additions & 26 deletions Doc/using/cmdline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -372,11 +372,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

Expand Down Expand Up @@ -542,23 +542,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
Expand All @@ -567,18 +566,13 @@ 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.
.. versionchanged:: 3.11
Added the ``-X no_debug_ranges``, ``-X frozen_modules`` and
``-X int_max_str_digits`` options.


Options you shouldn't use
Expand Down Expand Up @@ -895,11 +889,11 @@ conflict.
* ``malloc_debug``: same as ``malloc`` but also install debug hooks.
* ``pymalloc_debug``: same as ``pymalloc`` but also install debug hooks.

.. versionadded:: 3.6

.. versionchanged:: 3.7
Added the ``"default"`` allocator.

.. versionadded:: 3.6


.. envvar:: PYTHONMALLOCSTATS

Expand Down