Skip to content

Commit 9a97a89

Browse files
miss-islingtonCAM-Gerlach
miss-islington
and
CAM-Gerlach
authored
gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612)
(cherry picked from commit 9f68dab) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
1 parent 60c4bca commit 9a97a89

21 files changed

+46
-22
lines changed

‎Doc/library/aifc.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515

1616
.. deprecated:: 3.11
17-
The :mod:`aifc` module is deprecated (see :pep:`594` for details).
17+
The :mod:`aifc` module is deprecated
18+
(see :pep:`PEP 594 <594#aifc>` for details).
1819

1920
--------------
2021

‎Doc/library/asynchat.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
**Source code:** :source:`Lib/asynchat.py`
1212

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

1718
--------------

‎Doc/library/asyncore.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
**Source code:** :source:`Lib/asyncore.py`
1515

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

2021
--------------

‎Doc/library/audioop.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
:deprecated:
77

88
.. deprecated:: 3.11
9-
The :mod:`audioop` module is deprecated (see :pep:`594` for details).
9+
The :mod:`audioop` module is deprecated
10+
(see :pep:`PEP 594 <594#audioop>` for details).
1011

1112
--------------
1213

‎Doc/library/cgi.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
single: Common Gateway Interface
1717

1818
.. deprecated:: 3.11
19-
The :mod:`cgi` module is deprecated (see :pep:`594` for details).
19+
The :mod:`cgi` module is deprecated
20+
(see :pep:`PEP 594 <594#cgi>` for details and alternatives).
2021

2122
--------------
2223

‎Doc/library/cgitb.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
single: tracebacks; in CGI scripts
1818

1919
.. deprecated:: 3.11
20-
The :mod:`cgitb` module is deprecated (see :pep:`594` for details).
20+
The :mod:`cgitb` module is deprecated
21+
(see :pep:`PEP 594 <594#cgitb>` for details).
2122

2223
--------------
2324

‎Doc/library/chunk.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
single: RMFF
1919

2020
.. deprecated:: 3.11
21-
The :mod:`chunk` module is deprecated (see :pep:`594` for details).
21+
The :mod:`chunk` module is deprecated
22+
(see :pep:`PEP 594 <594#chunk>` for details).
2223

2324
--------------
2425

‎Doc/library/crypt.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717
pair: cipher; DES
1818

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

2224
--------------
2325

‎Doc/library/imghdr.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
**Source code:** :source:`Lib/imghdr.py`
99

1010
.. deprecated:: 3.11
11-
The :mod:`imghdr` module is deprecated (see :pep:`594` for details).
11+
The :mod:`imghdr` module is deprecated
12+
(see :pep:`PEP 594 <594#imghdr>` for details and alternatives).
1213

1314
--------------
1415

‎Doc/library/mailcap.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@
88
**Source code:** :source:`Lib/mailcap.py`
99

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

1415
--------------
1516

‎Doc/library/msilib.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
.. index:: single: msi
1515

1616
.. deprecated:: 3.11
17-
The :mod:`msilib` module is deprecated (see :pep:`594` for details).
17+
The :mod:`msilib` module is deprecated
18+
(see :pep:`PEP 594 <594#msilib>` for details).
1819

1920
--------------
2021

‎Doc/library/nis.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
1212

1313
.. deprecated:: 3.11
14-
The :mod:`nis` module is deprecated (see :pep:`594` for details).
14+
The :mod:`nis` module is deprecated
15+
(see :pep:`PEP 594 <594#nis>` for details).
1516

1617
--------------
1718

‎Doc/library/ossaudiodev.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
:deprecated:
88

99
.. deprecated:: 3.11
10-
The :mod:`ossaudiodev` module is deprecated (see :pep:`594` for details).
10+
The :mod:`ossaudiodev` module is deprecated
11+
(see :pep:`PEP 594 <594#ossaudiodev>` for details).
1112

1213
--------------
1314

‎Doc/library/pipes.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111
**Source code:** :source:`Lib/pipes.py`
1212

1313
.. deprecated:: 3.11
14-
The :mod:`pipes` module is deprecated (see :pep:`594` for details).
14+
The :mod:`pipes` module is deprecated
15+
(see :pep:`PEP 594 <594#pipes>` for details).
16+
Please use the :mod:`subprocess` module instead.
1517

1618
--------------
1719

‎Doc/library/smtpd.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
This module offers several classes to implement SMTP (email) servers.
1616

1717
.. deprecated:: 3.6
18-
:mod:`smtpd` will be removed in Python 3.12 (:pep:`594`).
18+
:mod:`smtpd` will be removed in Python 3.12
19+
(see :pep:`PEP 594 <594#smtpd>` for details).
1920
The `aiosmtpd <https://aiosmtpd.readthedocs.io/>`_ package is a recommended
2021
replacement for this module. It is based on :mod:`asyncio` and provides a
2122
more straightforward API.

‎Doc/library/sndhdr.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
single: u-LAW
1616

1717
.. deprecated:: 3.11
18-
The :mod:`sndhdr` module is deprecated (see :pep:`594` for details).
18+
The :mod:`sndhdr` module is deprecated
19+
(see :pep:`PEP 594 <594#sndhdr>` for details and alternatives).
1920

2021
--------------
2122

‎Doc/library/spwd.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
:deprecated:
88

99
.. deprecated:: 3.11
10-
The :mod:`spwd` module is deprecated (see :pep:`594` for details).
10+
The :mod:`spwd` module is deprecated
11+
(see :pep:`PEP 594 <594#spwd>` for details and alternatives).
1112

1213
--------------
1314

‎Doc/library/sunau.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
**Source code:** :source:`Lib/sunau.py`
1111

1212
.. deprecated:: 3.11
13-
The :mod:`sunau` module is deprecated (see :pep:`594` for details).
13+
The :mod:`sunau` module is deprecated
14+
(see :pep:`PEP 594 <594#sunau>` for details).
1415

1516
--------------
1617

‎Doc/library/telnetlib.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
.. index:: single: protocol; Telnet
1313

1414
.. deprecated:: 3.11
15-
The :mod:`telnetlib` module is deprecated (see :pep:`594` for details).
15+
The :mod:`telnetlib` module is deprecated
16+
(see :pep:`PEP 594 <594#telnetlib>` for details and alternatives).
1617

1718
--------------
1819

‎Doc/library/uu.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
**Source code:** :source:`Lib/uu.py`
1111

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

1517
--------------
1618

‎Doc/library/xdrlib.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
single: External Data Representation
1313

1414
.. deprecated:: 3.11
15-
The :mod:`xdrlib` module is deprecated (see :pep:`594` for details).
15+
The :mod:`xdrlib` module is deprecated
16+
(see :pep:`PEP 594 <594#xdrlib>` for details).
1617

1718
--------------
1819

0 commit comments

Comments
 (0)