gh-144329: Clarify that ._pth files are Windows-only in site module documentation #144335
+6
−1
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
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR fixes the ambiguity in the
sitemodule documentation regarding._pthfiles. As noted in issue gh-144329, the current text does not explicitly state that the underscore-prefixed.pthfiles are a feature exclusive to the Windows embeddable distribution.Changes
.. note::block toDoc/library/site.rstexplaining the Windows-only nature of._pthfiles.finding_modulessection for further technical context on isolated environments.Verification
I have built the documentation locally using
make html(on Windows viamake.bat html) and confirmed the new note renders correctly and the cross-reference link is functional.📚 Documentation preview 📚: https://cpython-previews--144335.org.readthedocs.build/