Skip to content

Commit

Permalink
pythongh-101100: Fix Sphinx warnings from removed ~! references (py…
Browse files Browse the repository at this point in the history
…thon#113629)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
hugovk and AlexWaygood authored Jan 2, 2024
1 parent 3aadb95 commit 7595380
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1860,7 +1860,7 @@ Standard Library

(Contributed by Erlend E. Aasland in :issue:`5846`.)

* :meth:`~!unittest.TestProgram.usageExit` is marked deprecated, to be removed
* :meth:`!unittest.TestProgram.usageExit` is marked deprecated, to be removed
in 3.13.
(Contributed by Carlos Damázio in :gh:`67048`.)

Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1052,7 +1052,7 @@ their ``__init__`` method (for example, file objects) or in their
crypt
-----

Addition of salt and modular crypt format (hashing method) and the :func:`~!crypt.mksalt`
Addition of salt and modular crypt format (hashing method) and the :func:`!mksalt`
function to the :mod:`!crypt` module.

(:issue:`10924`)
Expand Down
14 changes: 7 additions & 7 deletions Doc/whatsnew/3.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -605,15 +605,15 @@ Using ``ABC`` as a base class has essentially the same effect as specifying
aifc
----

The :meth:`~!aifc.aifc.getparams` method now returns a namedtuple rather than a
The :meth:`!getparams` method now returns a namedtuple rather than a
plain tuple. (Contributed by Claudiu Popa in :issue:`17818`.)

:func:`!aifc.open` now supports the context management protocol: when used in a
:keyword:`with` block, the :meth:`~!aifc.aifc.close` method of the returned
:keyword:`with` block, the :meth:`!close` method of the returned
object will be called automatically at the end of the block. (Contributed by
Serhiy Storchacha in :issue:`16486`.)

The :meth:`~!aifc.aifc.writeframesraw` and :meth:`~!aifc.aifc.writeframes`
The :meth:`!writeframesraw` and :meth:`!writeframes`
methods now accept any :term:`bytes-like object`. (Contributed by Serhiy
Storchaka in :issue:`8311`.)

Expand All @@ -632,7 +632,7 @@ audioop
:mod:`!audioop` now supports 24-bit samples. (Contributed by Serhiy Storchaka
in :issue:`12866`.)

New :func:`~!audioop.byteswap` function converts big-endian samples to
New :func:`!byteswap` function converts big-endian samples to
little-endian and vice versa. (Contributed by Serhiy Storchaka in
:issue:`19641`.)

Expand Down Expand Up @@ -1528,7 +1528,7 @@ work on Windows. This change was actually inadvertently made in 3.3.4.
sunau
-----

The :meth:`~!sunau.getparams` method now returns a namedtuple rather than a
The :meth:`!getparams` method now returns a namedtuple rather than a
plain tuple. (Contributed by Claudiu Popa in :issue:`18901`.)

:meth:`!sunau.open` now supports the context management protocol: when used in a
Expand All @@ -1540,8 +1540,8 @@ in :issue:`18878`.)
support for writing 24 sample using the module. (Contributed by
Serhiy Storchaka in :issue:`19261`.)

The :meth:`~!sunau.AU_write.writeframesraw` and
:meth:`~!sunau.AU_write.writeframes` methods now accept any :term:`bytes-like
The :meth:`!writeframesraw` and
:meth:`!writeframes` methods now accept any :term:`bytes-like
object`. (Contributed by Serhiy Storchaka in :issue:`8311`.)


Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1252,7 +1252,7 @@ Oberkirch in :issue:`21800`.)
imghdr
------

The :func:`~!imghdr.what` function now recognizes the
The :func:`!what` function now recognizes the
`OpenEXR <https://www.openexr.com>`_ format
(contributed by Martin Vignali and Claudiu Popa in :issue:`20295`),
and the `WebP <https://en.wikipedia.org/wiki/WebP>`_ format
Expand Down
8 changes: 4 additions & 4 deletions Doc/whatsnew/3.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ crypt
The :mod:`!crypt` module now supports the Blowfish hashing method.
(Contributed by Serhiy Storchaka in :issue:`31664`.)

The :func:`~!crypt.mksalt` function now allows specifying the number of rounds
The :func:`!mksalt` function now allows specifying the number of rounds
for hashing. (Contributed by Serhiy Storchaka in :issue:`31702`.)


Expand Down Expand Up @@ -2004,15 +2004,15 @@ importlib
---------

Methods
:meth:`MetaPathFinder.find_module() <!importlib.abc.MetaPathFinder.find_module>`
:meth:`!MetaPathFinder.find_module()`
(replaced by
:meth:`MetaPathFinder.find_spec() <importlib.abc.MetaPathFinder.find_spec>`)
and
:meth:`PathEntryFinder.find_loader() <!importlib.abc.PathEntryFinder.find_loader>`
:meth:`!PathEntryFinder.find_loader()`
(replaced by
:meth:`PathEntryFinder.find_spec() <importlib.abc.PathEntryFinder.find_spec>`)
both deprecated in Python 3.4 now emit :exc:`DeprecationWarning`.
(Contributed by Matthias Bussonnier in :issue:`29576`)
(Contributed by Matthias Bussonnier in :issue:`29576`.)

The :class:`importlib.abc.ResourceLoader` ABC has been deprecated in
favour of :class:`importlib.abc.ResourceReader`.
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.9.rst
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ queue.
nntplib
-------

:class:`~!nntplib.NNTP` and :class:`~!nntplib.NNTP_SSL` now raise a :class:`ValueError`
:class:`!NNTP` and :class:`!NNTP_SSL` now raise a :class:`ValueError`
if the given timeout for their constructor is zero to prevent the creation of
a non-blocking socket. (Contributed by Donghee Na in :issue:`39259`.)

Expand Down
6 changes: 3 additions & 3 deletions Misc/NEWS.d/3.11.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3483,9 +3483,9 @@ Improved reprs of :mod:`threading` synchronization objects:
Deprecated the following :mod:`unittest` functions, scheduled for removal in
Python 3.13:

* :func:`~!unittest.findTestCases`
* :func:`~!unittest.makeSuite`
* :func:`~!unittest.getTestCaseNames`
* :func:`!findTestCases`
* :func:`!makeSuite`
* :func:`!getTestCaseNames`

Use :class:`~unittest.TestLoader` methods instead:

Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.11.0a7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1038,8 +1038,8 @@ Add optional parameter *dir_fd* in :func:`shutil.rmtree`.
.. nonce: AixHW7
.. section: Library
:meth:`~!unittest.TestProgram.usageExit` is marked deprecated, to be removed
in 3.13.
:meth:`!unittest.TestProgram.usageExit` is marked as deprecated,
to be removed in Python 3.13.

..
Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.9.0a3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ resilients to inaccessible sys.path entries (importlib_metadata v1.4.0).
.. nonce: _S5VjC
.. section: Library
:class:`~!nntplib.NNTP` and :class:`~!nntplib.NNTP_SSL` now raise a
:class:`!NNTP` and :class:`!NNTP_SSL` now raise a
:class:`ValueError` if the given timeout for their constructor is zero to
prevent the creation of a non-blocking socket. Patch by Donghee Na.

Expand Down Expand Up @@ -498,7 +498,7 @@ prevent the creation of a non-blocking socket. Patch by Donghee Na.
.. section: Library
Updated the Gmane domain from news.gmane.org to news.gmane.io which is used
for examples of :class:`~!nntplib.NNTP` news reader server and nntplib tests.
for examples of :class:`!NNTP` news reader server and nntplib tests.

..
Expand Down

0 comments on commit 7595380

Please sign in to comment.