Skip to content

Commit 2f91ce5

Browse files
committed
Add and cross-link notes in optional module docs
1 parent cd7b042 commit 2f91ce5

File tree

7 files changed

+30
-1
lines changed

7 files changed

+30
-1
lines changed

Doc/includes/optional-module.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@ If it is missing from your copy of CPython,
33
look for documentation from your distributor (that is,
44
whoever provided Python to you).
55
If you are the distributor, see :ref:`optional-module-requirements`.
6+
7+
.. Notes similar wording appear in these module docs:
8+
- zipfile
9+
- tarfile

Doc/library/idle.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ IDLE has the following features:
3737

3838
* configuration, browsers, and other dialogs
3939

40+
.. include:: ../includes/optional-module.rst
41+
42+
4043
Menus
4144
-----
4245

Doc/library/tarfile.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ Some facts and figures:
2121
* reads and writes :mod:`gzip`, :mod:`bz2`, :mod:`compression.zstd`, and
2222
:mod:`lzma` compressed archives if the respective modules are available.
2323

24+
..
25+
The following paragraph should be similar to ../includes/optional-module.rst
26+
27+
If any of these :term:`optional modules <optional module>` are missing from
28+
your copy of CPython, look for documentation from your distributor (that is,
29+
whoever provided Python to you).
30+
If you are the distributor, see :ref:`optional-module-requirements`.
31+
2432
* read/write support for the POSIX.1-1988 (ustar) format.
2533

2634
* read/write support for the GNU tar format including *longname* and *longlink*

Doc/library/tkinter.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ details that are unchanged.
3636
Most documentation you will find online still uses the old API and
3737
can be woefully outdated.
3838

39+
.. include:: ../includes/optional-module.rst
40+
3941
.. seealso::
4042

4143
* `TkDocs <https://tkdocs.com/>`_

Doc/library/turtle.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ introduced in Logo <https://en.wikipedia.org/wiki/Turtle_
2929
(robot)>`_, developed by Wally Feurzeig, Seymour Papert and Cynthia Solomon
3030
in 1967.
3131

32+
.. include:: ../includes/optional-module.rst
33+
3234

3335
Get started
3436
===========

Doc/library/zipfile.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ decryption of encrypted files in ZIP archives, but it currently cannot
2323
create an encrypted file. Decryption is extremely slow as it is
2424
implemented in native Python rather than C.
2525

26+
..
27+
The following paragraph should be similar to ../includes/optional-module.rst
28+
29+
Handling compressed archives requires :term:`optional modules <optional module>`
30+
such as :mod:`zlib`, :mod:`bz2`, :mod:`lzma`, :mod:`~compression.zstd`.
31+
If any of them are missing from your copy of CPython,
32+
look for documentation from your distributor (that is,
33+
whoever provided Python to you).
34+
If you are the distributor, see :ref:`optional-module-requirements`.
35+
2636
The module defines the following items:
2737

2838
.. exception:: BadZipFile

Doc/using/configure.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Dependencies to build optional modules are:
101101
- :mod:`sqlite3`
102102
* - `Tcl/Tk <https://www.tcl-lang.org/>`_
103103
- 8.5.12
104-
- :mod:`tkinter`
104+
- :mod:`tkinter`, :ref:`IDLE <idle>`, :mod:`turtle`
105105
* - `zlib <https://www.zlib.net>`_
106106
- 1.2.2.1
107107
- :mod:`zlib`, :mod:`gzip`, :mod:`ensurepip`

0 commit comments

Comments
 (0)