gh-139707: Add docs for optional modules #140171
Open
+208
−77
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 <89152624+StanFromIreland@users.noreply.github.com>
|
|
hugovk
reviewed
Oct 15, 2025
vstinner
reviewed
Oct 16, 2025
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
encukou
requested review from
AA-Turner,
berkerpeksag,
corona10,
erlend-aasland,
ethanfurman,
gpshead,
pfmoore,
picnixz,
pradyunsg and
terryjreedy
as code owners
| you will need several third-party libraries installed for development | ||
| (for example, header files must be available). | ||
|
|
||
| Missing requirements are generally given in ``configure`` output. |
There was a problem hiding this comment.
Suggested change
| Missing requirements are generally given in ``configure`` output. | |
| Missing requirements are generally given in the ``configure`` output. |
There was a problem hiding this comment.
The original sounds better to me here -- I see configure spewing a mass of lines, rather than a report ;)
| (for example, header files must be available). | ||
|
|
||
| Missing requirements are generally given in ``configure`` output. | ||
| Missing optional modules are listed near the end of ``make`` output, |
There was a problem hiding this comment.
Suggested change
| Missing optional modules are listed near the end of ``make`` output, | |
| Missing optional modules are listed near the end of the ``make`` output, |
| optional module | ||
| An :term:`extension module` that is part of the :term:`standard library`, | ||
| but may be absent in some builds of :term:`CPython`, | ||
| usually due to missing third-party libraries. |
There was a problem hiding this comment.
Suggested change
| usually due to missing third-party libraries. | |
| usually due to missing third-party libraries or platform limitations. |
I would suggest noting platform too, e.g. the case of winreg, winsound etc.
An expanded suggestion:
Suggested change
| usually due to missing third-party libraries. | |
| usually due to missing third-party libraries or because the | |
| module is not supported on a given platform. |
There was a problem hiding this comment.
Hmm, should platform-specific modules be considered “optional”?
There was a problem hiding this comment.
... Well, I guess they should. I'll add notes in a few more places when I next get around to this.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
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/