Skip to content

gh-136437: Document some os.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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Jul 19, 2025

@chirizxc reached out to me and asked to take this issue over. So, here's mine PR :)

I scanned through all os.path functions 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


📚 Documentation preview 📚: https://cpython-previews--136812.org.readthedocs.build/

Copy link
Member

@AA-Turner AA-Turner left a 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

@sobolevn sobolevn merged commit b5428bb into python:main Jul 21, 2025
41 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 21, 2025
@miss-islington-app
Copy link

Thanks @sobolevn for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 21, 2025
…nly (pythonGH-136812)

(cherry picked from commit b5428bb)

Co-authored-by: sobolevn <mail@sobolevn.me>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 21, 2025
…nly (pythonGH-136812)

(cherry picked from commit b5428bb)

Co-authored-by: sobolevn <mail@sobolevn.me>
@bedevere-app
Copy link

bedevere-app bot commented Jul 21, 2025

GH-136944 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 21, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 21, 2025

GH-136945 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 21, 2025
sobolevn added a commit that referenced this pull request Jul 21, 2025
…only (GH-136812) (#136945)

gh-136437: Document some `os.path` functions as requiring pos-only (GH-136812)
(cherry picked from commit b5428bb)

Co-authored-by: sobolevn <mail@sobolevn.me>
sobolevn added a commit that referenced this pull request Jul 21, 2025
…only (GH-136812) (#136944)

gh-136437: Document some `os.path` functions as requiring pos-only (GH-136812)
(cherry picked from commit b5428bb)

Co-authored-by: sobolevn <mail@sobolevn.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy