Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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

This commit is contained in:
CAM Gerlach 2022-05-13 13:54:12 -06:00 committed by GitHub
parent 7e46ae33bd
commit 9f68dab3d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 46 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Doc/library/aifc.rst
View File

@ -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).
--------------

3
Doc/library/asynchat.rst
View File

@ -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.
--------------

3
Doc/library/asyncore.rst
View File

@ -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.
--------------

3
Doc/library/audioop.rst
View File

@ -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).
--------------

3
Doc/library/cgi.rst
View File

@ -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).
--------------

3
Doc/library/cgitb.rst
View File

@ -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).
--------------

3
Doc/library/chunk.rst
View File

@ -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).
--------------

4
Doc/library/crypt.rst
View File

@ -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.
--------------

3
Doc/library/imghdr.rst
View File

@ -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).
--------------

5
Doc/library/mailcap.rst
View File

@ -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.
--------------

3
Doc/library/msilib.rst
View File

@ -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).
--------------

3
Doc/library/nis.rst
View File

@ -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).
--------------

3
Doc/library/ossaudiodev.rst
View File

@ -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).
--------------

4
Doc/library/pipes.rst
View File

@ -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.
--------------

3
Doc/library/smtpd.rst
View File

@ -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.

3
Doc/library/sndhdr.rst
View File

@ -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).
--------------

3
Doc/library/spwd.rst
View File

@ -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).
--------------

3
Doc/library/sunau.rst
View File

@ -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).
--------------

3
Doc/library/telnetlib.rst
View File

@ -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).
--------------

4
Doc/library/uu.rst
View File

@ -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.
--------------

3
Doc/library/xdrlib.rst
View File

@ -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).
--------------