DOC: clarify and expand documentation about PYTHONUSERBASE and PYTHONNOUSERSITE #144637
+26
−16
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
Otherwise it is not clear how to disable user site-packages. Even though it is directly above, the link from the search results put the top of the page on PYHONUSERBASE and the user may not think to scroll up for critical context.
Now matches both site.rst and the actual implementation.
It is not otherwise documented that this implicitly disables user site-packages.
tacaswell
force-pushed
the
doc/usersite_details
branch
from
69f8de3 to
9cde670
Compare
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.
I erred on this not needing an issue to say "the docs could be improved" as that is always a true statement ;).
The changes are split up into individual commits for ease of review. The primary changes are:
include-system-site-packagesinpyvenv.cfgimplicitly also controls user site-packagessite.pydocstring (looks like it has always been wrong)📚 Documentation preview 📚: https://cpython-previews--144637.org.readthedocs.build/