gh-142895: Improve shlex.join docstring #144441
Closed
+12
−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. |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
Expand the terse docstring for shlex.join() to explain that it is the inverse of split() and that the result is shell-escaped. Add doctest examples showing round-trip behavior. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
kovan
force-pushed
the
gh-142895-shlex-join-docstring
branch
from
0384252 to
58eef72
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
Member
|
Fully AI-generated PRs are not accepted. Please do not open such PRs. |
Author
|
But the contribution is useful and/or productive; I don't think you are reading the document right. Please re-read. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Summary
shlex.join()to explain that it is the inverse ofsplit()and that the result is shell-escapedsplit()andjoin()Closes #142895
Test plan
make checkin Doc/ directory passed🤖 Generated with Claude Code
shlex.join's docstring isn't sufficiently clear #142895