Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[3.11] gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) #92785

Merged
merged 1 commit into from
May 13, 2022
Merged

[3.11] gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) #92785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion Doc/library/aifc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@


.. deprecated:: 3.11
The :mod:`aifc` module is deprecated (see :pep:`594` for details).
The :mod:`aifc` module is deprecated
(see :pep:`PEP 594 <594#aifc>` for details).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/asynchat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
**Source code:** :source:`Lib/asynchat.py`

.. deprecated:: 3.6
:mod:`asynchat` will be removed in Python 3.12 (:pep:`594`).
:mod:`asynchat` will be removed in Python 3.12
(see :pep:`PEP 594 <594#asynchat>` for details).
Please use :mod:`asyncio` instead.

--------------
Expand Down
3 changes: 2 additions & 1 deletion Doc/library/asyncore.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
**Source code:** :source:`Lib/asyncore.py`

.. deprecated:: 3.6
:mod:`asyncore` will be removed in Python 3.12 (:pep:`594`).
:mod:`asyncore` will be removed in Python 3.12
(see :pep:`PEP 594 <594#asyncore>` for details).
Please use :mod:`asyncio` instead.

--------------
Expand Down
3 changes: 2 additions & 1 deletion Doc/library/audioop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
:deprecated:

.. deprecated:: 3.11
The :mod:`audioop` module is deprecated (see :pep:`594` for details).
The :mod:`audioop` module is deprecated
(see :pep:`PEP 594 <594#audioop>` for details).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/cgi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
single: Common Gateway Interface

.. deprecated:: 3.11
The :mod:`cgi` module is deprecated (see :pep:`594` for details).
The :mod:`cgi` module is deprecated
(see :pep:`PEP 594 <594#cgi>` for details and alternatives).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/cgitb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
single: tracebacks; in CGI scripts

.. deprecated:: 3.11
The :mod:`cgitb` module is deprecated (see :pep:`594` for details).
The :mod:`cgitb` module is deprecated
(see :pep:`PEP 594 <594#cgitb>` for details).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/chunk.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
single: RMFF

.. deprecated:: 3.11
The :mod:`chunk` module is deprecated (see :pep:`594` for details).
The :mod:`chunk` module is deprecated
(see :pep:`PEP 594 <594#chunk>` for details).

--------------

Expand Down
4 changes: 3 additions & 1 deletion Doc/library/crypt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
pair: cipher; DES

.. deprecated:: 3.11
The :mod:`crypt` module is deprecated (see :pep:`594` for details).
The :mod:`crypt` module is deprecated
(see :pep:`PEP 594 <594#crypt>` for details and alternatives).
The :mod:`hashlib` module is a potential replacement for certain use cases.

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/imghdr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
**Source code:** :source:`Lib/imghdr.py`

.. deprecated:: 3.11
The :mod:`imghdr` module is deprecated (see :pep:`594` for details).
The :mod:`imghdr` module is deprecated
(see :pep:`PEP 594 <594#imghdr>` for details and alternatives).

--------------

Expand Down
5 changes: 3 additions & 2 deletions Doc/library/mailcap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
**Source code:** :source:`Lib/mailcap.py`

.. deprecated:: 3.11
The :mod:`mailcap` module is deprecated. See :pep:`594` for the rationale
and the :mod:`mimetypes` module for an alternative.
The :mod:`mailcap` module is deprecated
(see :pep:`PEP 594 <594#mailcap>` for details).
The :mod:`mimetypes` module provides an alternative.

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/msilib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
.. index:: single: msi

.. deprecated:: 3.11
The :mod:`msilib` module is deprecated (see :pep:`594` for details).
The :mod:`msilib` module is deprecated
(see :pep:`PEP 594 <594#msilib>` for details).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/nis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>

.. deprecated:: 3.11
The :mod:`nis` module is deprecated (see :pep:`594` for details).
The :mod:`nis` module is deprecated
(see :pep:`PEP 594 <594#nis>` for details).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/ossaudiodev.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
:deprecated:

.. deprecated:: 3.11
The :mod:`ossaudiodev` module is deprecated (see :pep:`594` for details).
The :mod:`ossaudiodev` module is deprecated
(see :pep:`PEP 594 <594#ossaudiodev>` for details).

--------------

Expand Down
4 changes: 3 additions & 1 deletion Doc/library/pipes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
**Source code:** :source:`Lib/pipes.py`

.. deprecated:: 3.11
The :mod:`pipes` module is deprecated (see :pep:`594` for details).
The :mod:`pipes` module is deprecated
(see :pep:`PEP 594 <594#pipes>` for details).
Please use the :mod:`subprocess` module instead.

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/smtpd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
This module offers several classes to implement SMTP (email) servers.

.. deprecated:: 3.6
:mod:`smtpd` will be removed in Python 3.12 (:pep:`594`).
:mod:`smtpd` will be removed in Python 3.12
(see :pep:`PEP 594 <594#smtpd>` for details).
The `aiosmtpd <https://aiosmtpd.readthedocs.io/>`_ package is a recommended
replacement for this module. It is based on :mod:`asyncio` and provides a
more straightforward API.
Expand Down
3 changes: 2 additions & 1 deletion Doc/library/sndhdr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
single: u-LAW

.. deprecated:: 3.11
The :mod:`sndhdr` module is deprecated (see :pep:`594` for details).
The :mod:`sndhdr` module is deprecated
(see :pep:`PEP 594 <594#sndhdr>` for details and alternatives).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/spwd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
:deprecated:

.. deprecated:: 3.11
The :mod:`spwd` module is deprecated (see :pep:`594` for details).
The :mod:`spwd` module is deprecated
(see :pep:`PEP 594 <594#spwd>` for details and alternatives).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/sunau.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
**Source code:** :source:`Lib/sunau.py`

.. deprecated:: 3.11
The :mod:`sunau` module is deprecated (see :pep:`594` for details).
The :mod:`sunau` module is deprecated
(see :pep:`PEP 594 <594#sunau>` for details).

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/telnetlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
.. index:: single: protocol; Telnet

.. deprecated:: 3.11
The :mod:`telnetlib` module is deprecated (see :pep:`594` for details).
The :mod:`telnetlib` module is deprecated
(see :pep:`PEP 594 <594#telnetlib>` for details and alternatives).

--------------

Expand Down
4 changes: 3 additions & 1 deletion Doc/library/uu.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
**Source code:** :source:`Lib/uu.py`

.. deprecated:: 3.11
The :mod:`uu` module is deprecated (see :pep:`594` for details).
The :mod:`uu` module is deprecated
(see :pep:`PEP 594 <594#uu-and-the-uu-encoding>` for details).
:mod:`base64` is a modern alternative.

--------------

Expand Down
3 changes: 2 additions & 1 deletion Doc/library/xdrlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
single: External Data Representation

.. deprecated:: 3.11
The :mod:`xdrlib` module is deprecated (see :pep:`594` for details).
The :mod:`xdrlib` module is deprecated
(see :pep:`PEP 594 <594#xdrlib>` for details).

--------------

Expand Down