summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo van Kemenade <1324225+hugovk@users.noreply.github.com>2024-01-05 13:31:28 (GMT)
committerGitHub <noreply@github.com>2024-01-05 13:31:28 (GMT)
commite56c53334f1adf5b4ea940036c76d18e80fe809d (patch)
treeb5fa99329da5d0f30482c8ce8a06dac67d2819ea
parent3003fbbf00422bce6e327646063e97470afa9091 (diff)
downloadcpython-e56c53334f1adf5b4ea940036c76d18e80fe809d.zip
cpython-e56c53334f1adf5b4ea940036c76d18e80fe809d.tar.gz
cpython-e56c53334f1adf5b4ea940036c76d18e80fe809d.tar.bz2
gh-101100: Fix Sphinx warnings for 2.6 deprecations and removals (#113725)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
-rw-r--r--Doc/library/subprocess.rst4
-rw-r--r--Doc/whatsnew/2.0.rst8
-rw-r--r--Doc/whatsnew/2.2.rst4
-rw-r--r--Doc/whatsnew/2.4.rst8
-rw-r--r--Doc/whatsnew/2.5.rst6
-rw-r--r--Doc/whatsnew/2.6.rst70
-rw-r--r--Doc/whatsnew/2.7.rst6
-rw-r--r--Doc/whatsnew/3.0.rst8
8 files changed, 57 insertions, 57 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index d6b892a..91e9fcf 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -1461,8 +1461,8 @@ Return code handling translates as follows::
print("There were some errors")
-Replacing functions from the :mod:`popen2` module
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Replacing functions from the :mod:`!popen2` module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. note::
diff --git a/Doc/whatsnew/2.0.rst b/Doc/whatsnew/2.0.rst
index b0e495b..620eb78 100644
--- a/Doc/whatsnew/2.0.rst
+++ b/Doc/whatsnew/2.0.rst
@@ -1095,8 +1095,8 @@ module.
GNU gettext message catalog library. (Integrated by Barry Warsaw, from separate
contributions by Martin von Löwis, Peter Funk, and James Henstridge.)
-* :mod:`linuxaudiodev`: Support for the :file:`/dev/audio` device on Linux, a
- twin to the existing :mod:`sunaudiodev` module. (Contributed by Peter Bosch,
+* :mod:`!linuxaudiodev`: Support for the :file:`/dev/audio` device on Linux, a
+ twin to the existing :mod:`!sunaudiodev` module. (Contributed by Peter Bosch,
with fixes by Jeremy Hylton.)
* :mod:`mmap`: An interface to memory-mapped files on both Windows and Unix. A
@@ -1139,8 +1139,8 @@ module.
Unix, not to be confused with :program:`gzip`\ -format files (which are
supported by the :mod:`gzip` module) (Contributed by James C. Ahlstrom.)
-* :mod:`imputil`: A module that provides a simpler way for writing customized
- import hooks, in comparison to the existing :mod:`ihooks` module. (Implemented
+* :mod:`!imputil`: A module that provides a simpler way for writing customized
+ import hooks, in comparison to the existing :mod:`!ihooks` module. (Implemented
by Greg Stein, with much discussion on python-dev along the way.)
.. ======================================================================
diff --git a/Doc/whatsnew/2.2.rst b/Doc/whatsnew/2.2.rst
index 6dfe79c..6efc23a 100644
--- a/Doc/whatsnew/2.2.rst
+++ b/Doc/whatsnew/2.2.rst
@@ -143,8 +143,8 @@ To make the set of types complete, new type objects such as :func:`dict` and
return fcntl.lockf(self.fileno(), operation,
length, start, whence)
-The now-obsolete :mod:`posixfile` module contained a class that emulated all of
-a file object's methods and also added a :meth:`lock` method, but this class
+The now-obsolete :mod:`!posixfile` module contained a class that emulated all of
+a file object's methods and also added a :meth:`!lock` method, but this class
couldn't be passed to internal functions that expected a built-in file,
something which is possible with our new :class:`LockableFile`.
diff --git a/Doc/whatsnew/2.4.rst b/Doc/whatsnew/2.4.rst
index e9a59f4..15d4003 100644
--- a/Doc/whatsnew/2.4.rst
+++ b/Doc/whatsnew/2.4.rst
@@ -387,13 +387,13 @@ The standard library provides a number of ways to execute a subprocess, offering
different features and different levels of complexity.
``os.system(command)`` is easy to use, but slow (it runs a shell process
which executes the command) and dangerous (you have to be careful about escaping
-the shell's metacharacters). The :mod:`popen2` module offers classes that can
+the shell's metacharacters). The :mod:`!popen2` module offers classes that can
capture standard output and standard error from the subprocess, but the naming
is confusing. The :mod:`subprocess` module cleans this up, providing a unified
interface that offers all the features you might need.
-Instead of :mod:`popen2`'s collection of classes, :mod:`subprocess` contains a
-single class called :class:`Popen` whose constructor supports a number of
+Instead of :mod:`!popen2`'s collection of classes, :mod:`subprocess` contains a
+single class called :class:`subprocess.Popen` whose constructor supports a number of
different keyword arguments. ::
class Popen(args, bufsize=0, executable=None,
@@ -1529,7 +1529,7 @@ code:
will now always be unequal, and relative comparisons (``<``, ``>``) will raise
a :exc:`TypeError`.
-* :func:`dircache.listdir` now passes exceptions to the caller instead of
+* :func:`!dircache.listdir` now passes exceptions to the caller instead of
returning empty lists.
* :func:`LexicalHandler.startDTD` used to receive the public and system IDs in
diff --git a/Doc/whatsnew/2.5.rst b/Doc/whatsnew/2.5.rst
index 627c918..f45d70e 100644
--- a/Doc/whatsnew/2.5.rst
+++ b/Doc/whatsnew/2.5.rst
@@ -1680,7 +1680,7 @@ The ctypes package
The :mod:`ctypes` package, written by Thomas Heller, has been added to the
standard library. :mod:`ctypes` lets you call arbitrary functions in shared
-libraries or DLLs. Long-time users may remember the :mod:`dl` module, which
+libraries or DLLs. Long-time users may remember the :mod:`!dl` module, which
provides functions for loading shared libraries and calling functions in them.
The :mod:`ctypes` package is much fancier.
@@ -1877,12 +1877,12 @@ The hashlib package
-------------------
A new :mod:`hashlib` module, written by Gregory P. Smith, has been added to
-replace the :mod:`md5` and :mod:`sha` modules. :mod:`hashlib` adds support for
+replace the :mod:`!md5` and :mod:`!sha` modules. :mod:`hashlib` adds support for
additional secure hashes (SHA-224, SHA-256, SHA-384, and SHA-512). When
available, the module uses OpenSSL for fast platform optimized implementations
of algorithms.
-The old :mod:`md5` and :mod:`sha` modules still exist as wrappers around hashlib
+The old :mod:`!md5` and :mod:`!sha` modules still exist as wrappers around hashlib
to preserve backwards compatibility. The new module's interface is very close
to that of the old modules, but not identical. The most significant difference
is that the constructor functions for creating new hashing objects are named
diff --git a/Doc/whatsnew/2.6.rst b/Doc/whatsnew/2.6.rst
index d947f61..93ddc7a 100644
--- a/Doc/whatsnew/2.6.rst
+++ b/Doc/whatsnew/2.6.rst
@@ -2916,8 +2916,8 @@ Deprecations and Removals
* Changes to the :class:`Exception` interface
as dictated by :pep:`352` continue to be made. For 2.6,
- the :attr:`message` attribute is being deprecated in favor of the
- :attr:`args` attribute.
+ the :attr:`!message` attribute is being deprecated in favor of the
+ :attr:`~BaseException.args` attribute.
* (3.0-warning mode) Python 3.0 will feature a reorganized standard
library that will drop many outdated modules and rename others.
@@ -2925,51 +2925,51 @@ Deprecations and Removals
when they are imported.
The list of deprecated modules is:
- :mod:`audiodev`,
- :mod:`bgenlocations`,
- :mod:`buildtools`,
- :mod:`bundlebuilder`,
- :mod:`Canvas`,
- :mod:`compiler`,
- :mod:`dircache`,
- :mod:`dl`,
- :mod:`fpformat`,
- :mod:`gensuitemodule`,
- :mod:`ihooks`,
- :mod:`imageop`,
- :mod:`imgfile`,
- :mod:`linuxaudiodev`,
- :mod:`mhlib`,
- :mod:`mimetools`,
- :mod:`multifile`,
- :mod:`new`,
- :mod:`pure`,
- :mod:`statvfs`,
- :mod:`sunaudiodev`,
- :mod:`test.testall`, and
- :mod:`toaiff`.
-
-* The :mod:`gopherlib` module has been removed.
-
-* The :mod:`MimeWriter` module and :mod:`mimify` module
+ :mod:`!audiodev`,
+ :mod:`!bgenlocations`,
+ :mod:`!buildtools`,
+ :mod:`!bundlebuilder`,
+ :mod:`!Canvas`,
+ :mod:`!compiler`,
+ :mod:`!dircache`,
+ :mod:`!dl`,
+ :mod:`!fpformat`,
+ :mod:`!gensuitemodule`,
+ :mod:`!ihooks`,
+ :mod:`!imageop`,
+ :mod:`!imgfile`,
+ :mod:`!linuxaudiodev`,
+ :mod:`!mhlib`,
+ :mod:`!mimetools`,
+ :mod:`!multifile`,
+ :mod:`!new`,
+ :mod:`!pure`,
+ :mod:`!statvfs`,
+ :mod:`!sunaudiodev`,
+ :mod:`!test.testall`, and
+ :mod:`!toaiff`.
+
+* The :mod:`!gopherlib` module has been removed.
+
+* The :mod:`!MimeWriter` module and :mod:`!mimify` module
have been deprecated; use the :mod:`email`
package instead.
-* The :mod:`md5` module has been deprecated; use the :mod:`hashlib` module
+* The :mod:`!md5` module has been deprecated; use the :mod:`hashlib` module
instead.
-* The :mod:`posixfile` module has been deprecated; :func:`fcntl.lockf`
+* The :mod:`!posixfile` module has been deprecated; :func:`fcntl.lockf`
provides better locking.
-* The :mod:`popen2` module has been deprecated; use the :mod:`subprocess`
+* The :mod:`!popen2` module has been deprecated; use the :mod:`subprocess`
module.
-* The :mod:`rgbimg` module has been removed.
+* The :mod:`!rgbimg` module has been removed.
-* The :mod:`sets` module has been deprecated; it's better to
+* The :mod:`!sets` module has been deprecated; it's better to
use the built-in :class:`set` and :class:`frozenset` types.
-* The :mod:`sha` module has been deprecated; use the :mod:`hashlib` module
+* The :mod:`!sha` module has been deprecated; use the :mod:`hashlib` module
instead.
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index 81fe132..fcad4bb 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -1315,9 +1315,9 @@ changes, or look through the Subversion logs for all the details.
giving the source address that will be used for the connection.
(Contributed by Eldon Ziegler; :issue:`3972`.)
-* The :mod:`ihooks` module now supports relative imports. Note that
- :mod:`ihooks` is an older module for customizing imports,
- superseded by the :mod:`imputil` module added in Python 2.0.
+* The :mod:`!ihooks` module now supports relative imports. Note that
+ :mod:`!ihooks` is an older module for customizing imports,
+ superseded by the :mod:`!imputil` module added in Python 2.0.
(Relative import support added by Neil Schemenauer.)
.. revision 75423
diff --git a/Doc/whatsnew/3.0.rst b/Doc/whatsnew/3.0.rst
index 89e1206..1df5209 100644
--- a/Doc/whatsnew/3.0.rst
+++ b/Doc/whatsnew/3.0.rst
@@ -555,8 +555,8 @@ very extensive changes to the standard library. :pep:`3108` is the
reference for the major changes to the library. Here's a capsule
review:
-* Many old modules were removed. Some, like :mod:`gopherlib` (no
- longer used) and :mod:`md5` (replaced by :mod:`hashlib`), were
+* Many old modules were removed. Some, like :mod:`!gopherlib` (no
+ longer used) and :mod:`!md5` (replaced by :mod:`hashlib`), were
already deprecated by :pep:`4`. Others were removed as a result
of the removal of support for various platforms such as Irix, BeOS
and Mac OS 9 (see :pep:`11`). Some modules were also selected for
@@ -626,7 +626,7 @@ review:
Some other changes to standard library modules, not covered by
:pep:`3108`:
-* Killed :mod:`sets`. Use the built-in :func:`set` class.
+* Killed :mod:`!sets`. Use the built-in :func:`set` class.
* Cleanup of the :mod:`sys` module: removed :func:`sys.exitfunc`,
:func:`sys.exc_clear`, :data:`sys.exc_type`, :data:`sys.exc_value`,
@@ -648,7 +648,7 @@ Some other changes to standard library modules, not covered by
* Cleanup of the :mod:`random` module: removed the :func:`jumpahead` API.
-* The :mod:`new` module is gone.
+* The :mod:`!new` module is gone.
* The functions :func:`os.tmpnam`, :func:`os.tempnam` and
:func:`os.tmpfile` have been removed in favor of the :mod:`tempfile`