From 9f68dab3d327335b938046c50b4f09944e993cc8 Mon Sep 17 00:00:00 2001
From: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Date: Fri, 13 May 2022 13:54:12 -0600
Subject: [PATCH] gh-92611: Link to PEP 594 sections & add key detail in doc
deprecation notices (GH-92612)
---
Doc/library/aifc.rst | 3 ++-
Doc/library/asynchat.rst | 3 ++-
Doc/library/asyncore.rst | 3 ++-
Doc/library/audioop.rst | 3 ++-
Doc/library/cgi.rst | 3 ++-
Doc/library/cgitb.rst | 3 ++-
Doc/library/chunk.rst | 3 ++-
Doc/library/crypt.rst | 4 +++-
Doc/library/imghdr.rst | 3 ++-
Doc/library/mailcap.rst | 5 +++--
Doc/library/msilib.rst | 3 ++-
Doc/library/nis.rst | 3 ++-
Doc/library/ossaudiodev.rst | 3 ++-
Doc/library/pipes.rst | 4 +++-
Doc/library/smtpd.rst | 3 ++-
Doc/library/sndhdr.rst | 3 ++-
Doc/library/spwd.rst | 3 ++-
Doc/library/sunau.rst | 3 ++-
Doc/library/telnetlib.rst | 3 ++-
Doc/library/uu.rst | 4 +++-
Doc/library/xdrlib.rst | 3 ++-
21 files changed, 46 insertions(+), 22 deletions(-)
diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst
index edb4bf86e5a..fa277857574 100644
--- a/Doc/library/aifc.rst
+++ b/Doc/library/aifc.rst
@@ -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).
--------------
diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst
index 4354444a1d3..7cc9d99779b 100644
--- a/Doc/library/asynchat.rst
+++ b/Doc/library/asynchat.rst
@@ -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.
--------------
diff --git a/Doc/library/asyncore.rst b/Doc/library/asyncore.rst
index e481e13db76..a732fd7ba4f 100644
--- a/Doc/library/asyncore.rst
+++ b/Doc/library/asyncore.rst
@@ -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.
--------------
diff --git a/Doc/library/audioop.rst b/Doc/library/audioop.rst
index eae206084f0..649c99e7962 100644
--- a/Doc/library/audioop.rst
+++ b/Doc/library/audioop.rst
@@ -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).
--------------
diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst
index 7e697408af0..31c03dee91e 100644
--- a/Doc/library/cgi.rst
+++ b/Doc/library/cgi.rst
@@ -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).
--------------
diff --git a/Doc/library/cgitb.rst b/Doc/library/cgitb.rst
index 349414610bd..3b0b106abac 100644
--- a/Doc/library/cgitb.rst
+++ b/Doc/library/cgitb.rst
@@ -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).
--------------
diff --git a/Doc/library/chunk.rst b/Doc/library/chunk.rst
index 7999420f536..5a84c8904f7 100644
--- a/Doc/library/chunk.rst
+++ b/Doc/library/chunk.rst
@@ -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).
--------------
diff --git a/Doc/library/crypt.rst b/Doc/library/crypt.rst
index 3189ece048a..e795f10f50e 100644
--- a/Doc/library/crypt.rst
+++ b/Doc/library/crypt.rst
@@ -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.
--------------
diff --git a/Doc/library/imghdr.rst b/Doc/library/imghdr.rst
index 084fef73daf..c17bf897b9b 100644
--- a/Doc/library/imghdr.rst
+++ b/Doc/library/imghdr.rst
@@ -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).
--------------
diff --git a/Doc/library/mailcap.rst b/Doc/library/mailcap.rst
index 416b181f45a..e2e5bb34456 100644
--- a/Doc/library/mailcap.rst
+++ b/Doc/library/mailcap.rst
@@ -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.
--------------
diff --git a/Doc/library/msilib.rst b/Doc/library/msilib.rst
index b2fa20873fb..1ee8130801c 100644
--- a/Doc/library/msilib.rst
+++ b/Doc/library/msilib.rst
@@ -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).
--------------
diff --git a/Doc/library/nis.rst b/Doc/library/nis.rst
index f6b6ea83946..49fe62954cc 100644
--- a/Doc/library/nis.rst
+++ b/Doc/library/nis.rst
@@ -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).
--------------
diff --git a/Doc/library/ossaudiodev.rst b/Doc/library/ossaudiodev.rst
index e0f0a6b8259..728ee303605 100644
--- a/Doc/library/ossaudiodev.rst
+++ b/Doc/library/ossaudiodev.rst
@@ -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).
--------------
diff --git a/Doc/library/pipes.rst b/Doc/library/pipes.rst
index 4de8c51bcae..1c5bb8bddaa 100644
--- a/Doc/library/pipes.rst
+++ b/Doc/library/pipes.rst
@@ -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.
--------------
diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst
index 6b37a051706..121790b5ed0 100644
--- a/Doc/library/smtpd.rst
+++ b/Doc/library/smtpd.rst
@@ -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.
diff --git a/Doc/library/sndhdr.rst b/Doc/library/sndhdr.rst
index 41bce18b9cd..3ca36f270da 100644
--- a/Doc/library/sndhdr.rst
+++ b/Doc/library/sndhdr.rst
@@ -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).
--------------
diff --git a/Doc/library/spwd.rst b/Doc/library/spwd.rst
index cb31a10a52e..40f50de07ba 100644
--- a/Doc/library/spwd.rst
+++ b/Doc/library/spwd.rst
@@ -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).
--------------
diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst
index cfb1257f585..b4d996e67e1 100644
--- a/Doc/library/sunau.rst
+++ b/Doc/library/sunau.rst
@@ -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).
--------------
diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst
index 97b0a713e44..48a927c8ac9 100644
--- a/Doc/library/telnetlib.rst
+++ b/Doc/library/telnetlib.rst
@@ -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).
--------------
diff --git a/Doc/library/uu.rst b/Doc/library/uu.rst
index c341bc83dcf..026ec415c9d 100644
--- a/Doc/library/uu.rst
+++ b/Doc/library/uu.rst
@@ -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.
--------------
diff --git a/Doc/library/xdrlib.rst b/Doc/library/xdrlib.rst
index 060b2e2c60d..a3124a98652 100644
--- a/Doc/library/xdrlib.rst
+++ b/Doc/library/xdrlib.rst
@@ -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).
--------------
--
GitLab