gh-136437: Document some os.path functions as requiring pos-only
#136812
+8
−8
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
sobolevn
added
needs backport to 3.13
bedevere-app
bot
added
awaiting core review
docs
AA-Turner
approved these changes
Jul 19, 2025
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.
@chirizxc reached out to me and asked to take this issue over. So, here's mine PR :)
I scanned through all
os.pathfunctions that do use different pos-or-keyword parameter name from the documented one. And added/to them. See #136437 (comment)I plan that we can backport this.
The second PR that I am working on is to actually make these functions pos-only in 3.15
os.pathdocumentation vs. runtime #136437📚 Documentation preview 📚: https://cpython-previews--136812.org.readthedocs.build/