Doc: Add "the current working directory" to -I's description
#100526
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
vstinner
reviewed
Jan 5, 2023
| In isolated mode :data:`sys.path` contains neither the script's directory nor | ||
| the user's site-packages directory. All :envvar:`PYTHON*` environment | ||
| In isolated mode, :data:`sys.path` does not contain the current working | ||
| directory, the script's directory, or the user's site-packages directory. |
There was a problem hiding this comment.
You may add something like:
(...): see the :option:`-P option <-P>` for details.
There was a problem hiding this comment.
I think this is already indicated in L302~L303. Wouldn't this be a duplication?
In summary:
the current working directory, the script's directorycomes from-Pthe user's site-packages directorycomes from-sAll :envvar:`PYTHON*` environmentcomes from-E
I am also wondering how to make it informative while being concise. 😂
Anyway, the point is, if the script's directory is mentioned, the current working directory should also be mentioned. Otherwise, they should all appear in the see ... for details part.
3 tasks
|
I'm not sure how to rephrase this documentation. I'm not a documentation expert :-) |
|
The following commit authors need to sign the Contributor License Agreement: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Per https://docs.python.org/3/using/cmdline.html#cmdoption-I,
-Iimplies-P, and-Pindicates "Don’t prepend the current working directory" when used with-mor-c:The description of
-Ionly mentions "the script's directory". "the current working directory" should be mentioned too.