shutil.which() docs reference os.environ as :data:
#124494
Merged
Conversation
This file contains 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 make use of :envvar: when talking about PATH and PATHEXT.
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
awaiting review
docs
AA-Turner
added
skip issue
needs backport to 3.12
|
Thanks @twm for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 25, 2024
…h()`` (pythonGH-124494) (cherry picked from commit 0d38409) Co-authored-by: Tom Most <[email protected]>
|
GH-124497 is a backport of this pull request to the 3.13 branch. |
|
Sorry, @twm and @AA-Turner, I could not cleanly backport this to |
|
Thanks Tom, are you able to handle backports to 3.12? Let me know if you have any problems with A |
|
@AA-Turner Sure, I will give it a try this evening! |
Yhg1s
pushed a commit
that referenced
this pull request
Sep 26, 2024
…il.which()`` (GH-124494) (#124497) Doc: Improve documentation for the ``path`` argument in ``shutil.which()`` (GH-124494) (cherry picked from commit 0d38409) Co-authored-by: Tom Most <[email protected]>
twm
added a commit
to twm/cpython
that referenced
this pull request
Sep 26, 2024
|
GH-124576 is a backport of this pull request to the 3.12 branch. |
twm
added a commit
to twm/cpython
that referenced
this pull request
Sep 26, 2024
|
GH-124576 is a backport of this pull request to the 3.12 branch. |
AA-Turner
pushed a commit
that referenced
this pull request
Sep 26, 2024
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.
The
shutil.which()docs referencedos.environusing:func:`os.environ`, which renders as "os.environ()" — nonsensical, as the mapping is not callable. The correct notation is:data:`os.environ`.I also made use of
:envvar:when talking about PATH and PATHEXT, following the pattern in the venv docs.I did not file an issue, nor create a blurb (the previous PR here didn't), as this change seems trivial. Happy to do so, though! I did reword the paragraph a bit, though most of the diff is caused by re-wrapping lines.
📚 Documentation preview 📚: https://cpython-previews--124494.org.readthedocs.build/en/124494/library/shutil.html