Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 35.2k
gh-139707: Add docs for optional modules#140171
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
d89a92d3cff681f8f2161c8f3521b9de7859f2c9e5145f0fccd7b0422f91ce512bf464644a7d588dc1227a7050b46d8713d62c8511146543828c39145f4ec366ac795File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| This is an :term:`optional module`. | ||
| If it is missing from your copy of CPython, | ||
| look for documentation from your distributor (that is, | ||
| whoever provided Python to you). | ||
| If you are the distributor, see :ref:`optional-module-requirements`. | ||
| .. Similar notes appear in the docs of the modules: | ||
| - zipfile | ||
| - tarfile |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -8,9 +8,9 @@ | ||
| -------------- | ||
| For applications that require data compression, the functions in this module | ||
| allow compression and decompression, using the zlib library. The zlib library | ||
| has its own home page at https://www.zlib.net. zlib 1.2.2.1 is the minium | ||
vstinner marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| supported version. | ||
| allow compression and decompression, using the `zlib library <https://www.zlib.net>`_. | ||
| .. include:: ../includes/optional-module.rst | ||
| zlib's functions have many options and often need to be used in a particular | ||
| order. This documentation doesn't attempt to cover all of the permutations; | ||
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the appropriate place for this, rather than buried in the idlelib entry at the end. Possible suggestion to make the include fit even better.
with
idleliblinked to the entry at the end of the file. OR I could do in a separate PR.I am also considering adding ":mod:
idleliband " to the beginning of the title in a separate issue. Would have to look at the result, including indexing.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I added this suggestion.