Skip to content

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

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

arthurlw
Copy link

@arthurlw arthurlw commented Feb 25, 2025

@ghost
Copy link

ghost commented Feb 25, 2025

All commit authors signed the Contributor License Agreement.
CLA signed

@picnixz
Copy link
Member

picnixz commented Feb 25, 2025

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.

@picnixz picnixz self-requested a review March 19, 2025 01:01
Copy link
Member

@picnixz 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


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

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)

@hugovk hugovk removed the needs backport to 3.12 only security fixes label Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting merge docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

4 participants