bpo-46826: document prefixes argument on site.getsitepackages #31546
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
slateny
reviewed
Oct 2, 2022
| Return a list containing all global :file:`site-packages` directories. | ||
|
|
||
| For each directory present in *prefixes* (or :data:`PREFIXES` if *prefixes* | ||
| is None), this function will find its :file:`site-packages` subdirectory |
There was a problem hiding this comment.
Suggested change
| is None), this function will find its :file:`site-packages` subdirectory | |
| is ``None``), this function will find its :file:`site-packages` subdirectory |
| @@ -0,0 +1 @@ | |||
| document prefixes argument on site.getsitepackages | |||
There was a problem hiding this comment.
As it's a doc change I'd say you can remove this file
Actually, since it documents a new parameter it might be useful to have the news.
Suggested change
| document prefixes argument on site.getsitepackages | |
| Document prefixes argument for :func:`~site.getsitepackages`. |
|
@asnelling Would you still be interested in giving the PR a quick update? |
| .. function:: getsitepackages(prefixes=None) | ||
|
|
||
| Return a list containing all global site-packages directories. | ||
| Return a list containing all global :file:`site-packages` directories. |
There was a problem hiding this comment.
Suggested change
| Return a list containing all global :file:`site-packages` directories. | |
| Return a list containing all global site-packages directories. |
This should be reverted, it does not do what you think it does.
| Return a list containing all global :file:`site-packages` directories. | ||
|
|
||
| For each directory present in *prefixes* (or :data:`PREFIXES` if *prefixes* | ||
| is None), this function will find its :file:`site-packages` subdirectory |
There was a problem hiding this comment.
Suggested change
| is None), this function will find its :file:`site-packages` subdirectory | |
| is None), this function will find its site-packages subdirectory |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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.
Adding
prefixesargument from code below to site.getsitepackages docs.cpython/Lib/site.py
Lines 346 to 352 in 7fce106
Introduced in commit 7ded1f0
https://bugs.python.org/issue46826