Skip to content

gh-130536: Add details to os.path documentation#130557

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.

Sign up for GitHub

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

Jump to bottom
Merged
hugovk merged 5 commits into from
Dec 16, 2025
Merged

gh-130536: Add details to os.path documentation #130557

hugovk merged 5 commits into from
Dec 16, 2025

Conversation

@arthurlw
Copy link
Contributor

@arthurlwarthurlw commented Feb 25, 2025•
edited
Loading

@ghost
Copy link

ghost commented Feb 25, 2025•
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-appbedevere-appbot added docs Documentation in the Doc dir skip news awaiting review labels Feb 25, 2025
@bedevere-appbedevere-appbot mentioned this pull request Feb 25, 2025
Open
picnixz
picnixz reviewed Feb 25, 2025
View reviewed changes
@picnixz
Copy link
Member

picnixz commented Feb 25, 2025•
edited
Loading

I don't think we need to explain in the seealso block what each function does. I think it's fine to have an inline "See also the functions X, Y and Z" to avoid repeating links (similar to what we currently do for os.path.split).

Note: I'm leaving until Saturday, so I won't have time to review the changes until then.

StanFromIreland
StanFromIreland reviewed Feb 27, 2025
View reviewed changes
@picnixzpicnixz self-requested a review March 19, 2025 01:01
@picnixzpicnixz requested a review from barneygaleMarch 23, 2025 11:08
@picnixzpicnixz mentioned this pull request Mar 29, 2025
Closed
@picnixzpicnixz added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 29, 2025
picnixz
picnixz reviewed Apr 4, 2025
View reviewed changes
Copy link
Member

@picnixzpicnixz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

friendly ping @barneygale

Doc/library/os.path.rst Outdated

If a segment is an absolute path (which on Windows requires both a drive and
a root), then all previous segments are ignored and joining continues from the
absolute path segment. For example::
Copy link
Member

@picnixzpicnixzApr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to confirm, this example is non-Windows only right? namely macOS and Linux right? If so, I would add "On Linux, for example::" (the paragraph is not exactly Linux specific but the example is)

Copy link
ContributorAuthor

@arthurlwarthurlwJul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay, good catch! I committed the fix

@hugovkhugovk removed the needs backport to 3.12 only security fixes label Apr 10, 2025
@serhiy-storchakaserhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
@hugovkhugovk changed the title gh-130536: Added details to os.path documentationgh-130536: Add details to os.path documentationDec 16, 2025
@hugovkhugovk merged commit ba587ed into python:mainDec 16, 2025
26 checks passed
@github-project-automationgithub-project-automationbot moved this from Todo to Done in Docs PRsDec 16, 2025
@miss-islington-app
Copy link

miss-islington-appbot commented Dec 16, 2025

Thanks @arthurlw for the PR, and @hugovk 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 Dec 16, 2025
@arthurlw@miss-islington
pythongh-130536: Add details toos.pathdocumentation (pythonGH-130557
1e57514
) (cherry picked from commit ba587ed) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 16, 2025
@arthurlw@miss-islington
pythongh-130536: Add details toos.pathdocumentation (pythonGH-130557
2b5da2d
) (cherry picked from commit ba587ed) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
@bedevere-app
Copy link

bedevere-appbot commented Dec 16, 2025

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

@bedevere-appbedevere-appbot removed the needs backport to 3.14 bugs and security fixes label Dec 16, 2025
@bedevere-app
Copy link

bedevere-appbot commented Dec 16, 2025

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

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label Dec 16, 2025
hugovk pushed a commit that referenced this pull request Dec 16, 2025
@miss-islington@arthurlw
[3.14]gh-130536: Add details toos.pathdocumentation (GH-130557) (#…
f162bcc
…142800) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
hugovk pushed a commit that referenced this pull request Dec 16, 2025
@miss-islington@arthurlw
[3.13]gh-130536: Add details toos.pathdocumentation (GH-130557) (#…
bce4a20
…142801) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixzpicnixzpicnixz approved these changes

@StanFromIrelandStanFromIrelandStanFromIreland left review comments

@barneygalebarneygaleAwaiting requested review from barneygale

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@arthurlw@picnixz@StanFromIreland@hugovk@serhiy-storchaka