Skip to content

gh-136437: Convert more os.path functions to pos-only in the docs #136970

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 22, 2025

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Jul 22, 2025

Notes for reviewing:

  • os.path.join has (a, *p) real signature vs (path, *paths) documented in posixpath
  • realpath has (filename, *, strict=False) real vs (path, *, strict=False) documented
  • commonprefix: (m) real vs (list) documented
  • several functions like getsize and get[a,m,c]time that have (filename) real vs (path) documented
  • samestat has (s1, s2) real vs (stat1, stat2) documented
  • samefile has (f1, f2) real vs (path1, path2) documented

Any others that I've missed?


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

@AA-Turner AA-Turner merged commit b31e5d6 into python:main Jul 22, 2025
40 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 22, 2025
@miss-islington-app
Copy link

Thanks @sobolevn for the PR, and @AA-Turner for merging it 🌮🎉.. 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 22, 2025
…y in the docs (pythonGH-136970)

(cherry picked from commit b31e5d6)

Co-authored-by: sobolevn <mail@sobolevn.me>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 22, 2025
…y in the docs (pythonGH-136970)

(cherry picked from commit b31e5d6)

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

bedevere-app bot commented Jul 22, 2025

GH-137000 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 22, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 22, 2025

GH-137001 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 22, 2025
AA-Turner pushed a commit that referenced this pull request Jul 22, 2025
…ly in the docs (GH-136970) (#137001)

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.

2 participants