https://github.com/python/cpython/commit/3efcf6673e46507e144e859fa9a33d1820380b9a
commit: 3efcf6673e46507e144e859fa9a33d1820380b9a
branch: 3.12
author: Erlend E. Aasland <erl...@python.org>
committer: erlend-aasland <erlend.aasl...@protonmail.com>
date: 2024-01-23T10:39:57+01:00
summary:
[3.12] Docs: align usage of versionadded/versionchanged with recommended
practice (#114409) (#114472)
(cherry picked from commit 1d7bddd9612bcbaaedbc837e2936de773e855411)
Co-authored-by: C.A.M. Gerlach <cam.gerl...@gerlach.cam>
Co-authored-by: Ezio Melotti <ezio.melo...@gmail.com>
files:
M Doc/library/argparse.rst
M Doc/library/asyncio-stream.rst
M Doc/library/bdb.rst
M Doc/library/concurrent.futures.rst
M Doc/library/configparser.rst
M Doc/library/datetime.rst
M Doc/library/difflib.rst
M Doc/library/email.policy.rst
M Doc/library/functions.rst
M Doc/library/functools.rst
M Doc/library/http.client.rst
M Doc/library/http.server.rst
M Doc/library/logging.config.rst
M Doc/library/logging.handlers.rst
M Doc/library/logging.rst
M Doc/library/os.rst
M Doc/library/pdb.rst
M Doc/library/pickletools.rst
M Doc/library/shutil.rst
M Doc/library/subprocess.rst
M Doc/library/unittest.rst
M Doc/library/urllib.parse.rst
M Doc/library/venv.rst
M Doc/library/xml.etree.elementtree.rst
M Doc/library/xml.sax.utils.rst
M Doc/library/zipapp.rst
M Doc/library/zipfile.rst
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index fbffa71d200735..1395d457f874b0 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1936,8 +1936,8 @@ FileType objects
>>> parser.parse_args(['-'])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)
- .. versionadded:: 3.4
- The *encodings* and *errors* keyword arguments.
+ .. versionchanged:: 3.4
+ Added the *encodings* and *errors* parameters.
Argument groups
diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst
index 91e5ba2f30e340..3ce6f4fa7d7e1e 100644
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -77,8 +77,8 @@ and work with streams:
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* parameter.
- .. versionadded:: 3.8
- Added *happy_eyeballs_delay* and *interleave* parameters.
+ .. versionchanged:: 3.8
+ Added the *happy_eyeballs_delay* and *interleave* parameters.
.. versionchanged:: 3.10
Removed the *loop* parameter.
diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst
index 4ce5c9bcde38ff..52f0ca7c013482 100644
--- a/Doc/library/bdb.rst
+++ b/Doc/library/bdb.rst
@@ -132,8 +132,8 @@ The :mod:`bdb` module also defines two classes:
frame is considered to originate in a certain module is determined
by the ``__name__`` in the frame globals.
- .. versionadded:: 3.1
- The *skip* argument.
+ .. versionchanged:: 3.1
+ Added the *skip* parameter.
The following methods of :class:`Bdb` normally don't need to be overridden.
diff --git a/Doc/library/concurrent.futures.rst
b/Doc/library/concurrent.futures.rst
index cc6df06e74cf27..4059bdb54fc411 100644
--- a/Doc/library/concurrent.futures.rst
+++ b/Doc/library/concurrent.futures.rst
@@ -171,8 +171,8 @@ And::
should be higher than the number of workers
for :class:`ProcessPoolExecutor`.
- .. versionadded:: 3.6
- The *thread_name_prefix* argument was added to allow users to
+ .. versionchanged:: 3.6
+ Added the *thread_name_prefix* parameter to allow users to
control the :class:`threading.Thread` names for worker threads created by
the pool for easier debugging.
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 0031737853e7b4..18e5bc20f3f690 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -1045,14 +1045,14 @@ ConfigParser Objects
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
encoding='cp1250')
- .. versionadded:: 3.2
- The *encoding* parameter. Previously, all files were read using the
- default encoding for :func:`open`.
+ .. versionchanged:: 3.2
+ Added the *encoding* parameter.
+ Previously, all files were read using the default encoding for
:func:`open`.
- .. versionadded:: 3.6.1
+ .. versionchanged:: 3.6.1
The *filenames* parameter accepts a :term:`path-like object`.
- .. versionadded:: 3.7
+ .. versionchanged:: 3.7
The *filenames* parameter accepts a :class:`bytes` object.
@@ -1291,9 +1291,9 @@ Exceptions
that is already present or in strict parsers when a section if found more
than once in a single input file, string or dictionary.
- .. versionadded:: 3.2
- Optional ``source`` and ``lineno`` attributes and arguments to
- :meth:`!__init__` were added.
+ .. versionchanged:: 3.2
+ Added the optional *source* and *lineno* attributes and parameters to
+ :meth:`!__init__`.
.. exception:: DuplicateOptionError
diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst
index f7f839fa4ff5d1..c74417e36eb402 100644
--- a/Doc/library/datetime.rst
+++ b/Doc/library/datetime.rst
@@ -856,8 +856,8 @@ Constructor:
If an argument outside those ranges is given, :exc:`ValueError` is raised.
- .. versionadded:: 3.6
- Added the ``fold`` argument.
+ .. versionchanged:: 3.6
+ Added the *fold* parameter.
Other constructors, all class methods:
@@ -1252,8 +1252,8 @@ Instance methods:
``tzinfo=None`` can be specified to create a naive datetime from an aware
datetime with no conversion of date and time data.
- .. versionadded:: 3.6
- Added the ``fold`` argument.
+ .. versionchanged:: 3.6
+ Added the *fold* parameter.
.. method:: datetime.astimezone(tz=None)
@@ -1496,8 +1496,8 @@ Instance methods:
>>> dt.isoformat(timespec='microseconds')
'2015-01-01T12:30:59.000000'
- .. versionadded:: 3.6
- Added the *timespec* argument.
+ .. versionchanged:: 3.6
+ Added the *timespec* parameter.
.. method:: datetime.__str__()
@@ -1830,8 +1830,8 @@ Instance methods:
``tzinfo=None`` can be specified to create a naive :class:`.time` from an
aware :class:`.time`, without conversion of the time data.
- .. versionadded:: 3.6
- Added the ``fold`` argument.
+ .. versionchanged:: 3.6
+ Added the *fold* parameter.
.. method:: time.isoformat(timespec='auto')
@@ -1874,8 +1874,8 @@ Instance methods:
>>> dt.isoformat(timespec='auto')
'12:34:56'
- .. versionadded:: 3.6
- Added the *timespec* argument.
+ .. versionchanged:: 3.6
+ Added the *timespec* parameter.
.. method:: time.__str__()
diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst
index 9abf19557f989c..d45e46448207a4 100644
--- a/Doc/library/difflib.rst
+++ b/Doc/library/difflib.rst
@@ -52,8 +52,8 @@ diffs. For comparing directories and files, see also, the
:mod:`filecmp` module.
the purpose of sequence matching. This heuristic can be turned off by
setting
the ``autojunk`` argument to ``False`` when creating the
:class:`SequenceMatcher`.
- .. versionadded:: 3.2
- The *autojunk* parameter.
+ .. versionchanged:: 3.2
+ Added the *autojunk* parameter.
.. class:: Differ
@@ -383,8 +383,8 @@ The :class:`SequenceMatcher` class has this constructor:
The optional argument *autojunk* can be used to disable the automatic junk
heuristic.
- .. versionadded:: 3.2
- The *autojunk* parameter.
+ .. versionchanged:: 3.2
+ Added the *autojunk* parameter.
SequenceMatcher objects get three data attributes: *bjunk* is the
set of elements of *b* for which *isjunk* is ``True``; *bpopular* is the
set of
diff --git a/Doc/library/email.policy.rst b/Doc/library/email.policy.rst
index fd47dd0dc5df36..f4777bb2462138 100644
--- a/Doc/library/email.policy.rst
+++ b/Doc/library/email.policy.rst
@@ -219,7 +219,6 @@ added matters. To illustrate::
Default: :const:`False`.
.. versionadded:: 3.5
- The *mangle_from_* parameter.
.. attribute:: message_factory
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index b24680f9bc2a90..fd16763b81d631 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1073,8 +1073,8 @@ are always available. They are listed here in
alphabetical order.
such as ``sorted(iterable, key=keyfunc, reverse=True)[0]`` and
``heapq.nlargest(1, iterable, key=keyfunc)``.
- .. versionadded:: 3.4
- The *default* keyword-only argument.
+ .. versionchanged:: 3.4
+ Added the *default* keyword-only parameter.
.. versionchanged:: 3.8
The *key* can be ``None``.
@@ -1111,8 +1111,8 @@ are always available. They are listed here in
alphabetical order.
such as ``sorted(iterable, key=keyfunc)[0]`` and ``heapq.nsmallest(1,
iterable, key=keyfunc)``.
- .. versionadded:: 3.4
- The *default* keyword-only argument.
+ .. versionchanged:: 3.4
+ Added the *default* keyword-only parameter.
.. versionchanged:: 3.8
The *key* can be ``None``.
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index f28fc8499139f1..724caa68dd7fc6 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -194,7 +194,7 @@ The :mod:`functools` module defines the following functions:
In contrast, the tuple arguments ``('answer', Decimal(42))`` and
``('answer', Fraction(42))`` are treated as equivalent.
- The wrapped function is instrumented with a :func:`cache_parameters`
+ The wrapped function is instrumented with a :func:`!cache_parameters`
function that returns a new :class:`dict` showing the values for *maxsize*
and *typed*. This is for information purposes only. Mutating the values
has no effect.
@@ -275,8 +275,8 @@ The :mod:`functools` module defines the following functions:
.. versionchanged:: 3.8
Added the *user_function* option.
- .. versionadded:: 3.9
- Added the function :func:`cache_parameters`
+ .. versionchanged:: 3.9
+ Added the function :func:`!cache_parameters`
.. decorator:: total_ordering
diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst
index 95b6c1f364bcc5..7e4502064f22a1 100644
--- a/Doc/library/http.client.rst
+++ b/Doc/library/http.client.rst
@@ -311,7 +311,7 @@ HTTPConnection Objects
:class:`str` or bytes-like object that is not also a file as the
body representation.
- .. versionadded:: 3.2
+ .. versionchanged:: 3.2
*body* can now be an iterable.
.. versionchanged:: 3.6
@@ -461,9 +461,8 @@ also send your request step by step, by using the four
functions below.
This is to avoid premature termination of the read of the request by
the target server due to malformed encoding.
- .. versionadded:: 3.6
- Chunked encoding support. The *encode_chunked* parameter was
- added.
+ .. versionchanged:: 3.6
+ Added chunked encoding support and the *encode_chunked* parameter.
.. method:: HTTPConnection.send(data)
diff --git a/Doc/library/http.server.rst b/Doc/library/http.server.rst
index a0b0d0caa32a32..eb3a6a87a11e58 100644
--- a/Doc/library/http.server.rst
+++ b/Doc/library/http.server.rst
@@ -328,8 +328,8 @@ provides three different variants:
or the current directory if *directory* is not provided, directly
mapping the directory structure to HTTP requests.
- .. versionadded:: 3.7
- The *directory* parameter.
+ .. versionchanged:: 3.7
+ Added the *directory* parameter.
.. versionchanged:: 3.9
The *directory* parameter accepts a :term:`path-like object`.
@@ -438,11 +438,11 @@ to bind to localhost only::
python -m http.server --bind 127.0.0.1
-.. versionadded:: 3.4
- ``--bind`` argument was introduced.
+.. versionchanged:: 3.4
+ Added the ``--bind`` option.
-.. versionadded:: 3.8
- ``--bind`` argument enhanced to support IPv6
+.. versionchanged:: 3.8
+ Support IPv6 in the ``--bind`` option.
By default, the server uses the current directory. The option
``-d/--directory``
specifies a directory to which it should serve the files. For example,
@@ -450,8 +450,8 @@ the following command uses a specific directory::
python -m http.server --directory /tmp/
-.. versionadded:: 3.7
- ``--directory`` argument was introduced.
+.. versionchanged:: 3.7
+ Added the ``--directory`` option.
By default, the server is conformant to HTTP/1.0. The option ``-p/--protocol``
specifies the HTTP version to which the server is conformant. For example, the
@@ -459,8 +459,8 @@ following command runs an HTTP/1.1 conformant server::
python -m http.server --protocol HTTP/1.1
-.. versionadded:: 3.11
- ``--protocol`` argument was introduced.
+.. versionchanged:: 3.11
+ Added the ``--protocol`` option.
.. class:: CGIHTTPRequestHandler(request, client_address, server)
@@ -524,5 +524,5 @@ default :class:`BaseHTTPRequestHandler` ``.log_message``
implementation. This could allow remote clients connecting to your
server to send nefarious control codes to your terminal.
-.. versionadded:: 3.12
+.. versionchanged:: 3.12
Control characters are scrubbed in stderr logs.
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index e1ecd3513078fe..34f2472816f6df 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -127,8 +127,8 @@ in :mod:`logging` itself) and defining handlers which are
declared either in
application (e.g. based on command-line parameters or other aspects
of the runtime environment) before being passed to ``fileConfig``.
- .. versionadded:: 3.10
- The *encoding* parameter is added.
+ .. versionchanged:: 3.10
+ Added the *encoding* parameter.
.. versionchanged:: 3.12
An exception will be thrown if the provided file
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index 2dd4bd081b0429..2fe9370333beaf 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -871,8 +871,8 @@ supports sending logging messages to an email address via
SMTP.
A timeout can be specified for communication with the SMTP server using the
*timeout* argument.
- .. versionadded:: 3.3
- The *timeout* argument was added.
+ .. versionchanged:: 3.3
+ Added the *timeout* parameter.
.. method:: emit(record)
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 6d1f048d283cee..c939fdb180b8c3 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -615,14 +615,14 @@ Formatter Objects
``logging.Formatter('%(ip)s %(message)s', defaults={"ip": None})``
:type defaults: dict[str, Any]
- .. versionadded:: 3.2
- The *style* parameter.
+ .. versionchanged:: 3.2
+ Added the *style* parameter.
- .. versionadded:: 3.8
- The *validate* parameter.
+ .. versionchanged:: 3.8
+ Added the *validate* parameter.
- .. versionadded:: 3.10
- The *defaults* parameter.
+ .. versionchanged:: 3.10
+ Added the *defaults* parameter.
.. method:: format(record)
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index c872ba5840c74e..c3e7e1f66d9346 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1251,8 +1251,8 @@ as internal buffering of data.
:meth:`~file.read` and :meth:`~file.write` methods (and many more). To
wrap a file descriptor in a file object, use :func:`fdopen`.
- .. versionadded:: 3.3
- The *dir_fd* argument.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.5
If the system call is interrupted and the signal handler does not raise
an
@@ -1988,7 +1988,7 @@ features:
.. audit-event:: os.chdir path os.chdir
- .. versionadded:: 3.3
+ .. versionchanged:: 3.3
Added support for specifying *path* as a file descriptor
on some platforms.
@@ -2020,8 +2020,8 @@ features:
.. availability:: Unix, not Emscripten, not WASI.
- .. versionadded:: 3.3
- The *follow_symlinks* argument.
+ .. versionchanged:: 3.3
+ Added the *follow_symlinks* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -2199,8 +2199,8 @@ features:
.. versionchanged:: 3.2
Added Windows support.
- .. versionadded:: 3.3
- Added the *src_dir_fd*, *dst_dir_fd*, and *follow_symlinks* arguments.
+ .. versionchanged:: 3.3
+ Added the *src_dir_fd*, *dst_dir_fd*, and *follow_symlinks* parameters.
.. versionchanged:: 3.6
Accepts a :term:`path-like object` for *src* and *dst*.
@@ -2364,8 +2364,8 @@ features:
.. audit-event:: os.mkdir path,mode,dir_fd os.mkdir
- .. versionadded:: 3.3
- The *dir_fd* argument.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -2398,8 +2398,8 @@ features:
.. audit-event:: os.mkdir path,mode,dir_fd os.makedirs
- .. versionadded:: 3.2
- The *exist_ok* parameter.
+ .. versionchanged:: 3.2
+ Added the *exist_ok* parameter.
.. versionchanged:: 3.4.1
@@ -2432,8 +2432,8 @@ features:
.. availability:: Unix, not Emscripten, not WASI.
- .. versionadded:: 3.3
- The *dir_fd* argument.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -2454,8 +2454,8 @@ features:
.. availability:: Unix, not Emscripten, not WASI.
- .. versionadded:: 3.3
- The *dir_fd* argument.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -2535,8 +2535,8 @@ features:
.. versionchanged:: 3.2
Added support for Windows 6.0 (Vista) symbolic links.
- .. versionadded:: 3.3
- The *dir_fd* argument.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object` on Unix.
@@ -2566,8 +2566,8 @@ features:
.. audit-event:: os.remove path,dir_fd os.remove
- .. versionadded:: 3.3
- The *dir_fd* argument.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -2617,8 +2617,8 @@ features:
.. audit-event:: os.rename src,dst,src_dir_fd,dst_dir_fd os.rename
- .. versionadded:: 3.3
- The *src_dir_fd* and *dst_dir_fd* arguments.
+ .. versionchanged:: 3.3
+ Added the *src_dir_fd* and *dst_dir_fd* parameters.
.. versionchanged:: 3.6
Accepts a :term:`path-like object` for *src* and *dst*.
@@ -2673,8 +2673,8 @@ features:
.. audit-event:: os.rmdir path,dir_fd os.rmdir
- .. versionadded:: 3.3
- The *dir_fd* parameter.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -2748,7 +2748,7 @@ features:
.. versionadded:: 3.5
- .. versionadded:: 3.6
+ .. versionchanged:: 3.6
Added support for the :term:`context manager` protocol and the
:func:`~scandir.close()` method. If a :func:`scandir` iterator is
neither
exhausted nor explicitly closed a :exc:`ResourceWarning` will be emitted
@@ -2962,9 +2962,9 @@ features:
:func:`fstat` and :func:`lstat` functions.
- .. versionadded:: 3.3
- Added the *dir_fd* and *follow_symlinks* arguments, specifying a file
- descriptor instead of a path.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* and *follow_symlinks* parameters,
+ specifying a file descriptor instead of a path.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -3045,16 +3045,22 @@ features:
Time of most recent access expressed in nanoseconds as an integer.
+ .. versionadded: 3.3
+
.. attribute:: st_mtime_ns
Time of most recent content modification expressed in nanoseconds as an
integer.
+ .. versionadded: 3.3
+
.. attribute:: st_ctime_ns
Time of most recent metadata change expressed in nanoseconds as an
integer.
+ .. versionadded: 3.3
+
.. versionchanged:: 3.12
``st_ctime_ns`` is deprecated on Windows. Use ``st_birthtime_ns``
for the file creation time. In the future, ``st_ctime`` will contain
@@ -3155,6 +3161,8 @@ features:
See the :const:`!FILE_ATTRIBUTE_* <stat.FILE_ATTRIBUTE_ARCHIVE>`
constants in the :mod:`stat` module.
+ .. versionadded:: 3.5
+
.. attribute:: st_reparse_tag
When :attr:`st_file_attributes` has the
:const:`~stat.FILE_ATTRIBUTE_REPARSE_POINT`
@@ -3175,13 +3183,6 @@ features:
some implementations. For compatibility with older Python versions,
accessing :class:`stat_result` as a tuple always returns integers.
- .. versionadded:: 3.3
- Added the :attr:`st_atime_ns`, :attr:`st_mtime_ns`, and
- :attr:`st_ctime_ns` members.
-
- .. versionadded:: 3.5
- Added the :attr:`st_file_attributes` member on Windows.
-
.. versionchanged:: 3.5
Windows now returns the file index as :attr:`st_ino` when
available.
@@ -3246,7 +3247,7 @@ features:
.. versionchanged:: 3.2
The :const:`ST_RDONLY` and :const:`ST_NOSUID` constants were added.
- .. versionadded:: 3.3
+ .. versionchanged:: 3.3
Added support for specifying *path* as an open file descriptor.
.. versionchanged:: 3.4
@@ -3258,8 +3259,8 @@ features:
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
- .. versionadded:: 3.7
- Added :attr:`f_fsid`.
+ .. versionchanged:: 3.7
+ Added the :attr:`f_fsid` attribute.
.. data:: supports_dir_fd
@@ -3383,8 +3384,8 @@ features:
.. versionchanged:: 3.2
Added support for Windows 6.0 (Vista) symbolic links.
- .. versionadded:: 3.3
- Added the *dir_fd* argument, and now allow *target_is_directory*
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter, and now allow *target_is_directory*
on non-Windows platforms.
.. versionchanged:: 3.6
@@ -3432,8 +3433,8 @@ features:
.. audit-event:: os.remove path,dir_fd os.unlink
- .. versionadded:: 3.3
- The *dir_fd* parameter.
+ .. versionchanged:: 3.3
+ Added the *dir_fd* parameter.
.. versionchanged:: 3.6
Accepts a :term:`path-like object`.
@@ -3471,7 +3472,7 @@ features:
.. audit-event:: os.utime path,times,ns,dir_fd os.utime
- .. versionadded:: 3.3
+ .. versionchanged:: 3.3
Added support for specifying *path* as an open file descriptor,
and the *dir_fd*, *follow_symlinks*, and *ns* parameters.
@@ -3995,7 +3996,7 @@ to be ignored.
.. availability:: Unix, Windows, not Emscripten, not WASI.
- .. versionadded:: 3.3
+ .. versionchanged:: 3.3
Added support for specifying *path* as an open file descriptor
for :func:`execve`.
@@ -4249,8 +4250,8 @@ written in Python, such as a mail server's external
command delivery program.
.. availability:: Unix, Windows, not Emscripten, not WASI.
- .. versionadded:: 3.2
- Windows support.
+ .. versionchanged:: 3.2
+ Added Windows support.
.. function:: killpg(pgid, sig, /)
diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst
index ef52370bff8058..785a8ab0c8a8c9 100644
--- a/Doc/library/pdb.rst
+++ b/Doc/library/pdb.rst
@@ -48,7 +48,7 @@ at the location you want to break into the debugger, and then
run the program.
You can then step through the code following this statement, and continue
running without the debugger using the :pdbcmd:`continue` command.
-.. versionadded:: 3.7
+.. versionchanged:: 3.7
The built-in :func:`breakpoint()`, when called with defaults, can be used
instead of ``import pdb; pdb.set_trace()``.
@@ -86,12 +86,12 @@ after normal exit of the program), pdb will restart the
program. Automatic
restarting preserves pdb's state (such as breakpoints) and in most cases is
more
useful than quitting the debugger upon program's exit.
-.. versionadded:: 3.2
- ``-c`` option is introduced to execute commands as if given
- in a :file:`.pdbrc` file, see :ref:`debugger-commands`.
+.. versionchanged:: 3.2
+ Added the ``-c`` option to execute commands as if given
+ in a :file:`.pdbrc` file; see :ref:`debugger-commands`.
-.. versionadded:: 3.7
- ``-m`` option is introduced to execute modules similar to the way
+.. versionchanged:: 3.7
+ Added the ``-m`` option to execute modules similar to the way
``python -m`` does. As with a script, the debugger will pause execution just
before the first line of the module.
@@ -209,12 +209,12 @@ access further features, you have to do this yourself:
.. audit-event:: pdb.Pdb "" pdb.Pdb
- .. versionadded:: 3.1
- The *skip* argument.
+ .. versionchanged:: 3.1
+ Added the *skip* parameter.
- .. versionadded:: 3.2
- The *nosigint* argument. Previously, a SIGINT handler was never set by
- Pdb.
+ .. versionchanged:: 3.2
+ Added the *nosigint* parameter.
+ Previously, a SIGINT handler was never set by Pdb.
.. versionchanged:: 3.6
The *readrc* argument.
@@ -463,8 +463,8 @@ can be overridden by the local file.
raised or propagated is indicated by ``>>``, if it differs from the current
line.
- .. versionadded:: 3.2
- The ``>>`` marker.
+ .. versionchanged:: 3.2
+ Added the ``>>`` marker.
.. pdbcommand:: ll | longlist
diff --git a/Doc/library/pickletools.rst b/Doc/library/pickletools.rst
index 41930f8cbe8412..9739207a224431 100644
--- a/Doc/library/pickletools.rst
+++ b/Doc/library/pickletools.rst
@@ -94,8 +94,8 @@ Programmatic Interface
a short description. The value of *annotate* is used as a hint for
the column where annotation should start.
- .. versionadded:: 3.2
- The *annotate* argument.
+ .. versionchanged:: 3.2
+ Added the *annotate* parameter.
.. function:: genops(pickle)
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index d1949d698f5614..b49cdd3a5b18b0 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -289,8 +289,8 @@ Directory and files operations
copy the file more efficiently. See
:ref:`shutil-platform-dependent-efficient-copy-operations` section.
- .. versionadded:: 3.8
- The *dirs_exist_ok* parameter.
+ .. versionchanged:: 3.8
+ Added the *dirs_exist_ok* parameter.
.. function:: rmtree(path, ignore_errors=False, onerror=None, *, onexc=None,
dir_fd=None)
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 91e9fcf0263d8d..c437ce770b37d0 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -308,10 +308,10 @@ default values. The arguments that are most commonly
needed are:
If text mode is not used, *stdin*, *stdout* and *stderr* will be opened as
binary streams. No encoding or line ending conversion is performed.
- .. versionadded:: 3.6
- Added *encoding* and *errors* parameters.
+ .. versionchanged:: 3.6
+ Added the *encoding* and *errors* parameters.
- .. versionadded:: 3.7
+ .. versionchanged:: 3.7
Added the *text* parameter as an alias for *universal_newlines*.
.. note::
@@ -684,8 +684,8 @@ functions.
is only changed on platforms that support this (only Linux at this time of
writing). Other platforms will ignore this parameter.
- .. versionadded:: 3.10
- The ``pipesize`` parameter was added.
+ .. versionchanged:: 3.10
+ Added the *pipesize* parameter.
Popen objects are supported as context managers via the :keyword:`with`
statement:
on exit, standard file descriptors are closed, and the process is waited
for.
@@ -1538,8 +1538,8 @@ handling consistency are valid for these functions.
as it did in Python 3.3.3 and earlier. exitcode has the same value as
:attr:`~Popen.returncode`.
- .. versionadded:: 3.11
- Added *encoding* and *errors* arguments.
+ .. versionchanged:: 3.11
+ Added the *encoding* and *errors* parameters.
.. function:: getoutput(cmd, *, encoding=None, errors=None)
@@ -1556,8 +1556,8 @@ handling consistency are valid for these functions.
.. versionchanged:: 3.3.4
Windows support added
- .. versionadded:: 3.11
- Added *encoding* and *errors* arguments.
+ .. versionchanged:: 3.11
+ Added the *encoding* and *errors* parameters.
Notes
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 7b45f33bff100c..d2f098cef3917d 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -2188,8 +2188,8 @@ Loading and running tests
.. versionadded:: 3.2
- .. versionadded:: 3.12
- Added *durations* keyword argument.
+ .. versionchanged:: 3.12
+ Added the *durations* keyword parameter.
.. data:: defaultTestLoader
diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst
index 53e5f0395715d7..3c898c3e826304 100644
--- a/Doc/library/urllib.parse.rst
+++ b/Doc/library/urllib.parse.rst
@@ -729,8 +729,8 @@ task isn't already covered by the URL parsing functions
above.
.. versionchanged:: 3.2
*query* supports bytes and string objects.
- .. versionadded:: 3.5
- *quote_via* parameter.
+ .. versionchanged:: 3.5
+ Added the *quote_via* parameter.
.. seealso::
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
index 18af1d41e4044b..8aaf5050b9c952 100644
--- a/Doc/library/venv.rst
+++ b/Doc/library/venv.rst
@@ -194,10 +194,10 @@ creation according to their needs, the
:class:`EnvBuilder` class.
.. versionchanged:: 3.4
Added the ``with_pip`` parameter
- .. versionadded:: 3.6
+ .. versionchanged:: 3.6
Added the ``prompt`` parameter
- .. versionadded:: 3.9
+ .. versionchanged:: 3.9
Added the ``upgrade_deps`` parameter
Creators of third-party virtual environment tools will be free to use the
diff --git a/Doc/library/xml.etree.elementtree.rst
b/Doc/library/xml.etree.elementtree.rst
index 57cfbb8d92244b..fe92400fb08dfd 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -705,11 +705,11 @@ Functions
meaning as in :meth:`ElementTree.write`. Returns an (optionally) encoded
string
containing the XML data.
- .. versionadded:: 3.4
- The *short_empty_elements* parameter.
+ .. versionchanged:: 3.4
+ Added the *short_empty_elements* parameter.
- .. versionadded:: 3.8
- The *xml_declaration* and *default_namespace* parameters.
+ .. versionchanged:: 3.8
+ Added the *xml_declaration* and *default_namespace* parameters.
.. versionchanged:: 3.8
The :func:`tostring` function now preserves the attribute order
@@ -732,11 +732,11 @@ Functions
.. versionadded:: 3.2
- .. versionadded:: 3.4
- The *short_empty_elements* parameter.
+ .. versionchanged:: 3.4
+ Added the *short_empty_elements* parameter.
- .. versionadded:: 3.8
- The *xml_declaration* and *default_namespace* parameters.
+ .. versionchanged:: 3.8
+ Added the *xml_declaration* and *default_namespace* parameters.
.. versionchanged:: 3.8
The :func:`tostringlist` function now preserves the attribute order
@@ -858,8 +858,8 @@ Functions
this is a Unicode string. If the loader fails, it can return None or
raise an exception.
- .. versionadded:: 3.9
- The *base_url* and *max_depth* parameters.
+ .. versionchanged:: 3.9
+ Added the *base_url* and *max_depth* parameters.
.. _elementtree-element-objects:
@@ -1189,8 +1189,8 @@ ElementTree Objects
:term:`file object`; make sure you do not try to write a string to a
binary stream and vice versa.
- .. versionadded:: 3.4
- The *short_empty_elements* parameter.
+ .. versionchanged:: 3.4
+ Added the *short_empty_elements* parameter.
.. versionchanged:: 3.8
The :meth:`write` method now preserves the attribute order specified
diff --git a/Doc/library/xml.sax.utils.rst b/Doc/library/xml.sax.utils.rst
index e57e76dcac7820..3a524c9c0d5a9f 100644
--- a/Doc/library/xml.sax.utils.rst
+++ b/Doc/library/xml.sax.utils.rst
@@ -71,8 +71,8 @@ or as base classes.
content: if ``False`` (the default) they are emitted as a pair of start/end
tags, if set to ``True`` they are emitted as a single self-closed tag.
- .. versionadded:: 3.2
- The *short_empty_elements* parameter.
+ .. versionchanged:: 3.2
+ Added the *short_empty_elements* parameter.
.. class:: XMLFilterBase(base)
diff --git a/Doc/library/zipapp.rst b/Doc/library/zipapp.rst
index 104afca23a20b4..c8a059bdb1cb93 100644
--- a/Doc/library/zipapp.rst
+++ b/Doc/library/zipapp.rst
@@ -171,8 +171,8 @@ The module defines two convenience functions:
passed to the ``zipfile.ZipFile`` class, and must supply the methods
needed by that class.
- .. versionadded:: 3.7
- Added the *filter* and *compressed* arguments.
+ .. versionchanged:: 3.7
+ Added the *filter* and *compressed* parameters.
.. function:: get_interpreter(archive)
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index c011656d9ef90c..d12bd68b1c97df 100644
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -213,7 +213,7 @@ ZipFile Objects
That flag takes precedence over *metadata_encoding*, which is
a Python-specific extension.
- .. versionadded:: 3.2
+ .. versionchanged:: 3.2
Added the ability to use :class:`ZipFile` as a context manager.
.. versionchanged:: 3.3
@@ -236,8 +236,8 @@ ZipFile Objects
.. versionchanged:: 3.7
Add the *compresslevel* parameter.
- .. versionadded:: 3.8
- The *strict_timestamps* keyword-only argument
+ .. versionchanged:: 3.8
+ The *strict_timestamps* keyword-only parameter.
.. versionchanged:: 3.11
Added support for specifying member name encoding for reading
@@ -642,8 +642,8 @@ The :class:`PyZipFile` constructor takes the same
parameters as the
.. class:: PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, \
optimize=-1)
- .. versionadded:: 3.2
- The *optimize* parameter.
+ .. versionchanged:: 3.2
+ Added the *optimize* parameter.
.. versionchanged:: 3.4
ZIP64 extensions are enabled by default.
@@ -698,8 +698,8 @@ The :class:`PyZipFile` constructor takes the same
parameters as the
test/bogus/__init__.pyc # Subpackage directory
test/bogus/myfile.pyc # Submodule test.bogus.myfile
- .. versionadded:: 3.4
- The *filterfunc* parameter.
+ .. versionchanged:: 3.4
+ Added the *filterfunc* parameter.
.. versionchanged:: 3.6.2
The *pathname* parameter accepts a :term:`path-like object`.
@@ -743,8 +743,8 @@ file:
.. versionchanged:: 3.6.2
The *filename* parameter accepts a :term:`path-like object`.
- .. versionadded:: 3.8
- The *strict_timestamps* keyword-only argument
+ .. versionchanged:: 3.8
+ Added the *strict_timestamps* keyword-only parameter.
Instances have the following methods and attributes:
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
