gh-139707: Add docs for optional modules #140171
Draft
+175
−76
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
... And add Stan as contributor: Co-authored-by: Stan Ulbrych <[email protected]>
Comment on lines
+1029
to
+1031
| An extension module that is part of the :term:`standard library`, but | ||
| may be missing in some builds of CPython, usually due to missing | ||
| third-party libraries. |
There was a problem hiding this comment.
Suggested change
| An extension module that is part of the :term:`standard library`, but | |
| may be missing in some builds of CPython, usually due to missing | |
| third-party libraries. | |
| An :term:`extension module` that is part of the :term:`standard library`, | |
| but may be absent in some builds of CPython, usually due to missing | |
| third-party libraries. |
Two suggestions:
- Link to the glossary term.
- "absent" rather than "missing"
There was a problem hiding this comment.
Do we want to link the CPython term too?
|
|
hugovk
reviewed
Oct 15, 2025
Comment on lines
+48
to
+49
| Requirements for Optional Modules | ||
| --------------------------------- |
There was a problem hiding this comment.
Use sentence case for headers:
https://devguide.python.org/documentation/style-guide/#capitalization
Suggested change
| Requirements for Optional Modules | |
| --------------------------------- | |
| Requirements for optional modules | |
| --------------------------------- |
|
|
||
| .. versionchanged:: 3.7 | ||
| Thread support and OpenSSL 1.0.2 are now required. | ||
| OpenSSL 1.0.2 are now required for :mod:`hashlib`. |
There was a problem hiding this comment.
Suggested change
| OpenSSL 1.0.2 are now required for :mod:`hashlib`. | |
| OpenSSL 1.0.2 is now required for :mod:`hashlib`. |
vstinner
reviewed
Oct 16, 2025
|
|
||
| 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 |
There was a problem hiding this comment.
Why not keeping the homepage link?
| - 1.4.5 | ||
| - :mod:`compression.zstd` | ||
|
|
||
| .. [1] If *libmpdec* is not available, CPython will use a bundled copy. |
There was a problem hiding this comment.
That changed in Python 3.15: https://docs.python.org/dev/whatsnew/3.15.html#build-changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📚 Documentation preview 📚: https://cpython-previews--140171.org.readthedocs.build/