gh-142895: Improve shlex.join documentation #142914
Closed
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. |
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation for the shlex.join() function by expanding its docstring to include a description of its relationship to shlex.split() and adding a practical example demonstrating its usage.
Key Changes:
- Enhanced the
shlex.join()docstring with clarification that it's the inverse ofshlex.split() - Added a doctest example showing how to join a command list into a shell-escaped string
- Added a NEWS entry documenting this improvement
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Misc/NEWS.d/next/Library/2025-12-17-20-55-24.gh-issue-142895.HKofui.rst | Adds a NEWS entry documenting the docstring improvement for shlex.join |
| Lib/shlex.py | Expands the shlex.join() docstring with a description and practical example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
As I said on the issue I believe it is bettet to update the online docs if needed rather than a docstring. We also do not use rst at the code level or doctests in general. |
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.
shlex.join's docstring isn't sufficiently clear #142895