Skip to content

Commit 78fa470

Browse files
authored
[3.14] Docs: remove links of modules to themselves (GH-144695) (#144705)
1 parent a77dde4 commit 78fa470

20 files changed

+145
-145
lines changed

Doc/library/codecs.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1544,8 +1544,8 @@ mapping. It is not supported by :meth:`str.encode` (which only produces
15441544
Restoration of the ``rot13`` alias.
15451545

15461546

1547-
:mod:`encodings` --- Encodings package
1548-
--------------------------------------
1547+
:mod:`!encodings` --- Encodings package
1548+
---------------------------------------
15491549

15501550
.. module:: encodings
15511551
:synopsis: Encodings package
@@ -1604,8 +1604,8 @@ This module implements the following exception:
16041604
Raised when a codec is invalid or incompatible.
16051605

16061606

1607-
:mod:`encodings.idna` --- Internationalized Domain Names in Applications
1608-
------------------------------------------------------------------------
1607+
:mod:`!encodings.idna` --- Internationalized Domain Names in Applications
1608+
-------------------------------------------------------------------------
16091609

16101610
.. module:: encodings.idna
16111611
:synopsis: Internationalized Domain Names implementation
@@ -1647,7 +1647,7 @@ When receiving host names from the wire (such as in reverse name lookup), no
16471647
automatic conversion to Unicode is performed: applications wishing to present
16481648
such host names to the user should decode them to Unicode.
16491649

1650-
The module :mod:`encodings.idna` also implements the nameprep procedure, which
1650+
The module :mod:`!encodings.idna` also implements the nameprep procedure, which
16511651
performs certain normalizations on host names, to achieve case-insensitivity of
16521652
international domain names, and to unify similar characters. The nameprep
16531653
functions can be used directly if desired.
@@ -1670,8 +1670,8 @@ functions can be used directly if desired.
16701670
Convert a label to Unicode, as specified in :rfc:`3490`.
16711671

16721672

1673-
:mod:`encodings.mbcs` --- Windows ANSI codepage
1674-
-----------------------------------------------
1673+
:mod:`!encodings.mbcs` --- Windows ANSI codepage
1674+
------------------------------------------------
16751675

16761676
.. module:: encodings.mbcs
16771677
:synopsis: Windows ANSI codepage
@@ -1688,8 +1688,8 @@ This module implements the ANSI codepage (CP_ACP).
16881688
Support any error handler.
16891689

16901690

1691-
:mod:`encodings.utf_8_sig` --- UTF-8 codec with BOM signature
1692-
-------------------------------------------------------------
1691+
:mod:`!encodings.utf_8_sig` --- UTF-8 codec with BOM signature
1692+
--------------------------------------------------------------
16931693

16941694
.. module:: encodings.utf_8_sig
16951695
:synopsis: UTF-8 codec with BOM signature

Doc/library/curses.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1824,22 +1824,22 @@ The following table lists the predefined colors:
18241824
+-------------------------+----------------------------+
18251825

18261826

1827-
:mod:`curses.textpad` --- Text input widget for curses programs
1828-
===============================================================
1827+
:mod:`!curses.textpad` --- Text input widget for curses programs
1828+
================================================================
18291829

18301830
.. module:: curses.textpad
18311831
:synopsis: Emacs-like input editing in a curses window.
18321832
.. moduleauthor:: Eric Raymond <esr@thyrsus.com>
18331833
.. sectionauthor:: Eric Raymond <esr@thyrsus.com>
18341834

18351835

1836-
The :mod:`curses.textpad` module provides a :class:`Textbox` class that handles
1836+
The :mod:`!curses.textpad` module provides a :class:`Textbox` class that handles
18371837
elementary text editing in a curses window, supporting a set of keybindings
18381838
resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,
18391839
FrameMaker, and many other programs). The module also provides a
18401840
rectangle-drawing function useful for framing text boxes or for other purposes.
18411841

1842-
The module :mod:`curses.textpad` defines the following function:
1842+
The module :mod:`!curses.textpad` defines the following function:
18431843

18441844

18451845
.. function:: rectangle(win, uly, ulx, lry, lrx)

Doc/library/dbm.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ then prints out the contents of the database::
151151

152152
The individual submodules are described in the following sections.
153153

154-
:mod:`dbm.sqlite3` --- SQLite backend for dbm
155-
---------------------------------------------
154+
:mod:`!dbm.sqlite3` --- SQLite backend for dbm
155+
----------------------------------------------
156156

157157
.. module:: dbm.sqlite3
158158
:platform: All
@@ -166,7 +166,7 @@ The individual submodules are described in the following sections.
166166

167167
This module uses the standard library :mod:`sqlite3` module to provide an
168168
SQLite backend for the :mod:`!dbm` module.
169-
The files created by :mod:`dbm.sqlite3` can thus be opened by :mod:`sqlite3`,
169+
The files created by :mod:`!dbm.sqlite3` can thus be opened by :mod:`sqlite3`,
170170
or any other SQLite browser, including the SQLite CLI.
171171

172172
.. include:: ../includes/wasm-notavail.rst
@@ -202,8 +202,8 @@ or any other SQLite browser, including the SQLite CLI.
202202
Close the SQLite database.
203203

204204

205-
:mod:`dbm.gnu` --- GNU database manager
206-
---------------------------------------
205+
:mod:`!dbm.gnu` --- GNU database manager
206+
----------------------------------------
207207

208208
.. module:: dbm.gnu
209209
:platform: Unix
@@ -213,20 +213,20 @@ or any other SQLite browser, including the SQLite CLI.
213213

214214
--------------
215215

216-
The :mod:`dbm.gnu` module provides an interface to the :abbr:`GDBM (GNU dbm)`
216+
The :mod:`!dbm.gnu` module provides an interface to the :abbr:`GDBM (GNU dbm)`
217217
library, similar to the :mod:`dbm.ndbm` module, but with additional
218218
functionality like crash tolerance.
219219

220220
.. note::
221221

222-
The file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible
222+
The file formats created by :mod:`!dbm.gnu` and :mod:`dbm.ndbm` are incompatible
223223
and can not be used interchangeably.
224224

225225
.. include:: ../includes/wasm-mobile-notavail.rst
226226

227227
.. exception:: error
228228

229-
Raised on :mod:`dbm.gnu`-specific errors, such as I/O errors. :exc:`KeyError` is
229+
Raised on :mod:`!dbm.gnu`-specific errors, such as I/O errors. :exc:`KeyError` is
230230
raised for general mapping errors like specifying an incorrect key.
231231

232232

@@ -321,8 +321,8 @@ functionality like crash tolerance.
321321
unwritten data to be written to the disk.
322322

323323

324-
:mod:`dbm.ndbm` --- New Database Manager
325-
----------------------------------------
324+
:mod:`!dbm.ndbm` --- New Database Manager
325+
-----------------------------------------
326326

327327
.. module:: dbm.ndbm
328328
:platform: Unix
@@ -332,14 +332,14 @@ functionality like crash tolerance.
332332

333333
--------------
334334

335-
The :mod:`dbm.ndbm` module provides an interface to the
335+
The :mod:`!dbm.ndbm` module provides an interface to the
336336
:abbr:`NDBM (New Database Manager)` library.
337337
This module can be used with the "classic" NDBM interface or the
338338
:abbr:`GDBM (GNU dbm)` compatibility interface.
339339

340340
.. note::
341341

342-
The file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible
342+
The file formats created by :mod:`dbm.gnu` and :mod:`!dbm.ndbm` are incompatible
343343
and can not be used interchangeably.
344344

345345
.. warning::
@@ -353,7 +353,7 @@ This module can be used with the "classic" NDBM interface or the
353353

354354
.. exception:: error
355355

356-
Raised on :mod:`dbm.ndbm`-specific errors, such as I/O errors. :exc:`KeyError` is raised
356+
Raised on :mod:`!dbm.ndbm`-specific errors, such as I/O errors. :exc:`KeyError` is raised
357357
for general mapping errors like specifying an incorrect key.
358358

359359

@@ -403,8 +403,8 @@ This module can be used with the "classic" NDBM interface or the
403403
Close the NDBM database.
404404

405405

406-
:mod:`dbm.dumb` --- Portable DBM implementation
407-
-----------------------------------------------
406+
:mod:`!dbm.dumb` --- Portable DBM implementation
407+
------------------------------------------------
408408

409409
.. module:: dbm.dumb
410410
:synopsis: Portable implementation of the simple DBM interface.
@@ -415,14 +415,14 @@ This module can be used with the "classic" NDBM interface or the
415415

416416
.. note::
417417

418-
The :mod:`dbm.dumb` module is intended as a last resort fallback for the
419-
:mod:`!dbm` module when a more robust module is not available. The :mod:`dbm.dumb`
418+
The :mod:`!dbm.dumb` module is intended as a last resort fallback for the
419+
:mod:`!dbm` module when a more robust module is not available. The :mod:`!dbm.dumb`
420420
module is not written for speed and is not nearly as heavily used as the other
421421
database modules.
422422

423423
--------------
424424

425-
The :mod:`dbm.dumb` module provides a persistent :class:`dict`-like
425+
The :mod:`!dbm.dumb` module provides a persistent :class:`dict`-like
426426
interface which is written entirely in Python.
427427
Unlike other :mod:`!dbm` backends, such as :mod:`dbm.gnu`, no
428428
external library is required.
@@ -431,7 +431,7 @@ The :mod:`!dbm.dumb` module defines the following:
431431

432432
.. exception:: error
433433

434-
Raised on :mod:`dbm.dumb`-specific errors, such as I/O errors. :exc:`KeyError` is
434+
Raised on :mod:`!dbm.dumb`-specific errors, such as I/O errors. :exc:`KeyError` is
435435
raised for general mapping errors like specifying an incorrect key.
436436

437437

Doc/library/dialog.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Tkinter Dialogs
22
===============
33

4-
:mod:`tkinter.simpledialog` --- Standard Tkinter input dialogs
5-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4+
:mod:`!tkinter.simpledialog` --- Standard Tkinter input dialogs
5+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
66

77
.. module:: tkinter.simpledialog
88
:platform: Tk
@@ -12,7 +12,7 @@ Tkinter Dialogs
1212

1313
--------------
1414

15-
The :mod:`tkinter.simpledialog` module contains convenience classes and
15+
The :mod:`!tkinter.simpledialog` module contains convenience classes and
1616
functions for creating simple modal dialogs to get a value from the user.
1717

1818

@@ -39,8 +39,8 @@ functions for creating simple modal dialogs to get a value from the user.
3939

4040

4141

42-
:mod:`tkinter.filedialog` --- File selection dialogs
43-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42+
:mod:`!tkinter.filedialog` --- File selection dialogs
43+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4444

4545
.. module:: tkinter.filedialog
4646
:platform: Tk
@@ -50,7 +50,7 @@ functions for creating simple modal dialogs to get a value from the user.
5050

5151
--------------
5252

53-
The :mod:`tkinter.filedialog` module provides classes and factory functions for
53+
The :mod:`!tkinter.filedialog` module provides classes and factory functions for
5454
creating file/directory selection windows.
5555

5656
Native Load/Save Dialogs
@@ -204,8 +204,8 @@ These do not emulate the native look-and-feel of the platform.
204204
directory. Confirmation is required if an already existing file is
205205
selected.
206206

207-
:mod:`tkinter.commondialog` --- Dialog window templates
208-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
207+
:mod:`!tkinter.commondialog` --- Dialog window templates
208+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
209209

210210
.. module:: tkinter.commondialog
211211
:platform: Tk
@@ -215,7 +215,7 @@ These do not emulate the native look-and-feel of the platform.
215215

216216
--------------
217217

218-
The :mod:`tkinter.commondialog` module provides the :class:`Dialog` class that
218+
The :mod:`!tkinter.commondialog` module provides the :class:`Dialog` class that
219219
is the base class for dialogs defined in other supporting modules.
220220

221221
.. class:: Dialog(master=None, **options)

Doc/library/email.encoders.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ is especially true for :mimetype:`image/\*` and :mimetype:`text/\*` type message
2525
containing binary data.
2626

2727
The :mod:`email` package provides some convenient encoders in its
28-
:mod:`~email.encoders` module. These encoders are actually used by the
28+
:mod:`!encoders` module. These encoders are actually used by the
2929
:class:`~email.mime.audio.MIMEAudio` and :class:`~email.mime.image.MIMEImage`
3030
class constructors to provide default encodings. All encoder functions take
3131
exactly one argument, the message object to encode. They usually extract the

Doc/library/email.policy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ The header objects and their attributes are described in
602602

603603
This concrete :class:`Policy` is the backward compatibility policy. It
604604
replicates the behavior of the email package in Python 3.2. The
605-
:mod:`~email.policy` module also defines an instance of this class,
605+
:mod:`!policy` module also defines an instance of this class,
606606
:const:`compat32`, that is used as the default policy. Thus the default
607607
behavior of the email package is to maintain compatibility with Python 3.2.
608608

Doc/library/importlib.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@ Functions
211211
in unexpected behavior. It's recommended to use the :class:`threading.Lock`
212212
or other synchronization primitives for thread-safe module reloading.
213213

214-
:mod:`importlib.abc` -- Abstract base classes related to import
215-
---------------------------------------------------------------
214+
:mod:`!importlib.abc` -- Abstract base classes related to import
215+
----------------------------------------------------------------
216216

217217
.. module:: importlib.abc
218218
:synopsis: Abstract base classes related to import
@@ -222,7 +222,7 @@ Functions
222222
--------------
223223

224224

225-
The :mod:`importlib.abc` module contains all of the core abstract base classes
225+
The :mod:`!importlib.abc` module contains all of the core abstract base classes
226226
used by :keyword:`import`. Some subclasses of the core abstract base classes
227227
are also provided to help in implementing the core ABCs.
228228

@@ -637,8 +637,8 @@ ABC hierarchy::
637637
itself does not end in ``__init__``.
638638

639639

640-
:mod:`importlib.machinery` -- Importers and path hooks
641-
------------------------------------------------------
640+
:mod:`!importlib.machinery` -- Importers and path hooks
641+
-------------------------------------------------------
642642

643643
.. module:: importlib.machinery
644644
:synopsis: Importers and path hooks
@@ -1136,8 +1136,8 @@ find and load modules.
11361136
Path to the ``.fwork`` file for the extension module.
11371137

11381138

1139-
:mod:`importlib.util` -- Utility code for importers
1140-
---------------------------------------------------
1139+
:mod:`!importlib.util` -- Utility code for importers
1140+
----------------------------------------------------
11411141

11421142
.. module:: importlib.util
11431143
:synopsis: Utility code for importers

Doc/library/json.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -748,7 +748,7 @@ Command-line interface
748748
--------------
749749

750750
The :mod:`!json` module can be invoked as a script via ``python -m json``
751-
to validate and pretty-print JSON objects. The :mod:`json.tool` submodule
751+
to validate and pretty-print JSON objects. The :mod:`!json.tool` submodule
752752
implements this interface.
753753

754754
If the optional ``infile`` and ``outfile`` arguments are not

Doc/library/multiprocessing.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ processes:
279279
p.join()
280280

281281
Queues are thread and process safe.
282-
Any object put into a :mod:`~multiprocessing` queue will be serialized.
282+
Any object put into a :mod:`!multiprocessing` queue will be serialized.
283283

284284
**Pipes**
285285

@@ -1715,13 +1715,13 @@ inherited by child processes.
17151715
attributes which allow one to use it to store and retrieve strings.
17161716

17171717

1718-
The :mod:`multiprocessing.sharedctypes` module
1719-
""""""""""""""""""""""""""""""""""""""""""""""
1718+
The :mod:`!multiprocessing.sharedctypes` module
1719+
"""""""""""""""""""""""""""""""""""""""""""""""
17201720

17211721
.. module:: multiprocessing.sharedctypes
17221722
:synopsis: Allocate ctypes objects from shared memory.
17231723

1724-
The :mod:`multiprocessing.sharedctypes` module provides functions for allocating
1724+
The :mod:`!multiprocessing.sharedctypes` module provides functions for allocating
17251725
:mod:`ctypes` objects from shared memory which can be inherited by child
17261726
processes.
17271727

@@ -2648,7 +2648,7 @@ Usually message passing between processes is done using queues or by using
26482648
:class:`~Connection` objects returned by
26492649
:func:`~multiprocessing.Pipe`.
26502650

2651-
However, the :mod:`multiprocessing.connection` module allows some extra
2651+
However, the :mod:`!multiprocessing.connection` module allows some extra
26522652
flexibility. It basically gives a high level message oriented API for dealing
26532653
with sockets or Windows named pipes. It also has support for *digest
26542654
authentication* using the :mod:`hmac` module, and for polling
@@ -2955,18 +2955,18 @@ Below is an example session with logging turned on::
29552955
For a full table of logging levels, see the :mod:`logging` module.
29562956

29572957

2958-
The :mod:`multiprocessing.dummy` module
2959-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2958+
The :mod:`!multiprocessing.dummy` module
2959+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29602960

29612961
.. module:: multiprocessing.dummy
29622962
:synopsis: Dumb wrapper around threading.
29632963

2964-
:mod:`multiprocessing.dummy` replicates the API of :mod:`!multiprocessing` but is
2964+
:mod:`!multiprocessing.dummy` replicates the API of :mod:`!multiprocessing` but is
29652965
no more than a wrapper around the :mod:`threading` module.
29662966

29672967
.. currentmodule:: multiprocessing.pool
29682968

2969-
In particular, the ``Pool`` function provided by :mod:`multiprocessing.dummy`
2969+
In particular, the ``Pool`` function provided by :mod:`!multiprocessing.dummy`
29702970
returns an instance of :class:`ThreadPool`, which is a subclass of
29712971
:class:`Pool` that supports all the same method calls but uses a pool of
29722972
worker threads rather than worker processes.

0 commit comments

Comments
 (0)