gh-130536: Add details to os.path documentation
#130557
Conversation
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
|
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 Note: I'm leaving until Saturday, so I won't have time to review the changes until then. |
picnixz
added
needs backport to 3.12
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:: |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
Sorry for the delay, good catch! I committed the fix
hugovk
changed the title
os.path documentationos.path documentation
) (cherry picked from commit ba587ed) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
) (cherry picked from commit ba587ed) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
|
GH-142800 is a backport of this pull request to the 3.14 branch. |
|
GH-142801 is a backport of this pull request to the 3.13 branch. |
…142800) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
…142801) Co-authored-by: Arthur Wigo <arthur.l.wigo@gmail.com>
5 participants
Potential solution to #130536
os.pathdocumentation #130536📚 Documentation preview 📚: https://cpython-previews--130557.org.readthedocs.build/