gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH...

diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst
index edb4bf86e5a0aae57c83db8e2d9d14fcfa6cc681..fa277857574a3a6c8fcfafbd6a3b2aa865872d91 100644 (file)
--- 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 4354444a1d3314a57d63dd5c38f15034143bd378..7cc9d99779bbbb299e45ac89a04eedfe94943a71 100644 (file)
--- 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 e481e13db76f70204b0990839170d9050bce22d1..a732fd7ba4f152525dd5d7dd3c89bbbc42cb12df 100644 (file)
--- 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 eae206084f09004ffb7cf888ca48efb09437082d..649c99e796282c116250ca2de4995cf28a7451d0 100644 (file)
--- 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 7e697408af07bc44a6725816766c9bc7a8a4d69c..31c03dee91ea82e829e84b5964a1d9da026af25f 100644 (file)
--- 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 349414610bd40a7375b5c4b5436660f3688f8f97..3b0b106abacd50b4ffbb79b1af976849881655ad 100644 (file)
--- 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 7999420f536d762becefbb06a39589ec0379b1a4..5a84c8904f71457a62e516b39fe0c5d71d0fbc32 100644 (file)
--- 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 3189ece048a26efc040a9d51ffe5b235dd0183d3..e795f10f50eec33ce5ddfe3a067ef64b1bd830d3 100644 (file)
--- 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 084fef73daf28dd474315cac88dd7fd25f00a3c7..c17bf897b9be91bb451f6d578f4ce442c6e2caea 100644 (file)
--- 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 416b181f45a772ad5052dd6d959d64fec4a252bf..e2e5bb34456373a399550da0f3e0845a67220320 100644 (file)
--- 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 b2fa20873fbbf660b6cdcf11f153554140f16480..1ee8130801cba5330e40539a2f14c7ce2d7c7eff 100644 (file)
--- 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 f6b6ea83946b0ed496abbea6b4e3cb981bf9435e..49fe62954cce8a04ffd8f4973b077eb0e94bc75b 100644 (file)
--- 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 e0f0a6b8259e4f4deb19214e091213a9f53d90d0..728ee3036057dd34c4a2a6803915e924865607c2 100644 (file)
--- 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 4de8c51bcae049f9f48176c68937f5718e60e88c..1c5bb8bddaafbc9dda2492622f89d62152f6431d 100644 (file)
--- 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 6b37a0517063d013deb87f47f5975bcc803d7ac6..121790b5ed0ddf2443d45bc73b1b16f237e169ca 100644 (file)
--- 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 41bce18b9cd849a4fb85630aec5e390033e946a7..3ca36f270dade14bc690a7f2b9d5b7065f015a12 100644 (file)
--- 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 cb31a10a52e0017a850be468b1dd8197fef9ef74..40f50de07babff30a04fe4cb0691bfcab7f37c69 100644 (file)
--- 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 cfb1257f585484b91a09b95488b9a11650e50254..b4d996e67e17cfacf28be22dfde9e46d8492396a 100644 (file)
--- 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 97b0a713e442238d1e73301112d48aa999acb15a..48a927c8ac96b2efbfa70b2d0cfa37c58fdd32ae 100644 (file)
--- 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 c341bc83dcfed0aca91303c15f6728ffd6961771..026ec415c9da650925dde0985ae0be3ee3c1c128 100644 (file)
--- 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 060b2e2c60df6d6cba3225f1f47dd8577e35cf58..a3124a986524bd8344a9f3b7da671f52e4d0f7ea 100644 (file)
--- 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).
 
 --------------