NotificationsYou must be signed in to change notification settings
Fork32k
Star67.3k

gh-130536: Added 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.

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

Jump to bottom

Open

arthurlw wants to merge3 commits intopython:main

base:main

Choose a base branch

fromarthurlw:main

Open

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

arthurlw wants to merge3 commits intopython:mainfromarthurlw:main

+26 −9

Conversation

Copy link

arthurlw commentedFeb 25, 2025•
edited
Loading

Potential solution to#130536

Issue:Reorganizeos.path documentation #130536

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

Update os.path.rst

a978c6c

Copy link

ghost commentedFeb 25, 2025•
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.

bedevere-appbot added docs

Documentation in the Doc dir

skip news awaiting review labels

Feb 25, 2025

bedevere-appbot mentioned this pull request

Feb 25, 2025

Reorganizeos.path documentation#130536

Open

picnixz reviewed

Feb 25, 2025

View reviewed changes

Doc/library/os.path.rst OutdatedShow resolvedHide resolved

Copy link

Member

picnixz commentedFeb 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 foros.path.split).

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

Adjusted os.path.rst details

231335f

StanFromIreland reviewed

Feb 27, 2025

View reviewed changes

Doc/library/os.path.rstShow resolvedHide resolved

Doc/library/os.path.rst OutdatedShow resolvedHide resolved

Update os.path.rst

953a2e3

picnixz self-requested a review

March 19, 2025 01:01

picnixz approved these changes

Mar 23, 2025

View reviewed changes

bedevere-appbot added awaiting merge and removed awaiting review labels

Mar 23, 2025

picnixz requested a review frombarneygale

March 23, 2025 11:08

picnixz mentioned this pull request

Mar 29, 2025

gh-130536: Improve os.path documentation#131872

Closed

picnixz added needs backport to 3.12

only security fixes

needs backport to 3.13bugs and security fixes labels

Mar 29, 2025

picnixz reviewed

Apr 4, 2025

View reviewed changes

Copy link

Member

picnixz 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


		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

picnixzApr 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)