GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-130536: Add details to `os.path` documentation by arthurlw · Pull Request #130557 · python/cpython

Conversation

@arthurlw

@arthurlw arthurlw commented Feb 25, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Potential solution to #130536

  • Issue: Reorganize os.path documentation #130536

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@arthurlw
Update os.path.rst
a978c6c
@ghost

ghost commented Feb 25, 2025 •
edited by ghost
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 25, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Feb 25, 2025
Reorganize os.path documentation #130536
Open
picnixz
picnixz reviewed Feb 25, 2025
View reviewed changes
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@picnixz

picnixz commented Feb 25, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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.
arthurlw reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@arthurlw
Adjusted os.path.rst details
231335f
StanFromIreland
StanFromIreland reviewed Feb 27, 2025
View reviewed changes
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/os.path.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@arthurlw
Update os.path.rst
953a2e3
@picnixz
picnixz self-requested a review March 19, 2025 01:01
picnixz
picnixz approved these changes Mar 23, 2025
View reviewed changes
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting review labels Mar 23, 2025
@picnixz
picnixz requested a review from barneygale March 23, 2025 11:08
@picnixz picnixz mentioned this pull request Mar 29, 2025
gh-130536: Improve os.path documentation #131872
Closed
@picnixz picnixz added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Mar 29, 2025
picnixz
picnixz reviewed Apr 4, 2025
View reviewed changes

@picnixz picnixz left a comment

Copy link
Copy Markdown
Member

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.

friendly ping @barneygale

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread 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::

@picnixz picnixz Apr 4, 2025

Copy link
Copy Markdown
Member

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.

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)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@arthurlw arthurlw Jul 14, 2025

Copy link
Copy Markdown
Contributor Author

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@hugovk hugovk removed the needs backport to 3.12 only security fixes label Apr 10, 2025
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
arthurlw added 2 commits July 14, 2025 09:54
@arthurlw
Merge branch 'main' into main
a1d754f
@arthurlw
Specify os.path.join example to Linux
2a39268
@hugovk hugovk changed the title gh-130536: Added details to os.path documentation gh-130536: Add details to os.path documentation Dec 16, 2025
@hugovk
hugovk merged commit ba587ed into python:main Dec 16, 2025
1 check passed

Uh oh!

There was an error while loading. Please reload this page.
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Dec 16, 2025
@miss-islington-app

miss-islington-app Bot commented Dec 16, 2025

Copy link
Copy Markdown

Thanks @arthurlw for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting merge label Dec 16, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 16, 2025
@arthurlw @miss-islington
pythongh-130536: Add details to os.path documentation (pythonGH-130557
1e57514 
)

(cherry picked from commit ba587ed)

Co-authored-by: Arthur Wigo <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 16, 2025
@arthurlw @miss-islington
pythongh-130536: Add details to os.path documentation (pythonGH-130557
2b5da2d 
)

(cherry picked from commit ba587ed)

Co-authored-by: Arthur Wigo <[email protected]>
@bedevere-app

bedevere-app Bot commented Dec 16, 2025

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Dec 16, 2025
@bedevere-app

bedevere-app Bot commented Dec 16, 2025

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only 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 to os.path documentation (GH-130557) (#…
f162bcc 
…142800)

Co-authored-by: Arthur Wigo <[email protected]>
hugovk pushed a commit that referenced this pull request Dec 16, 2025
@miss-islington @arthurlw
[3.13] gh-130536: Add details to os.path documentation (GH-130557) (#…
bce4a20 
…142801)

Co-authored-by: Arthur Wigo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz approved these changes
@StanFromIreland StanFromIreland StanFromIreland left review comments
@barneygale barneygale Awaiting requested review from barneygale

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@arthurlw @picnixz @StanFromIreland @hugovk @serhiy-storchaka
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.