Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.4k
gh-136437: Document someos.path functions as requiring pos-only#136812
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
sobolevn wants to merge1 commit intopython:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+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
AA-Turner approved these changesJul 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think this is a net improvement -- I still have slight reservations about the trailing '/', but we've discussed a couple of mitigations (e.g. in JS). Happy to support this.
A
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
awaiting mergedocsDocumentation in the Doc dir needs backport to 3.13bugs and security fixes needs backport to 3.14bugs and security fixes skip news
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.
Uh oh!
There was an error while loading.Please reload this page.
@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/