[Python-checkins] gh-77607: Improve accuracy of os.path.join docs (#101406)
hauntsaninja
webhook-mailer at python.org
Tue Jan 31 00:39:37 EST 2023
https://github.com/python/cpython/commit/909a6746939ea1d09fab21f26b558cfd7e3e29a0
commit: 909a6746939ea1d09fab21f26b558cfd7e3e29a0
branch: main
author: Shantanu <12621235+hauntsaninja at users.noreply.github.com>
committer: hauntsaninja <12621235+hauntsaninja at users.noreply.github.com>
date: 2023-01-30T21:39:30-08:00
summary:
gh-77607: Improve accuracy of os.path.join docs (#101406)
This is a follow-up to #100811.
One of the changes in that PR isn't accurate in that
`os.path.join('', '')` will not end in a separator.
This reverts that change to the previous wording that used "only", but
explicitly calls out the case where the last part ends in a separator,
which is what caused confusin in #77607 and motivated the change
in #100811.
files:
M Doc/library/os.path.rst
diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst
index 786c2fd7f64f..96bcb48ad7d1 100644
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -308,11 +308,11 @@ the :mod:`glob` module.)
Join one or more path segments intelligently. The return value is the
concatenation of *path* and all members of *\*paths*, with exactly one
- directory separator following each non-empty part except the last. That is,
- if the last part is empty, the result will end in a separator. 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.
+ directory separator following each non-empty part, except the last. That is,
+ the result will only end in a separator if the last part is either empty or
+ ends in a separator. 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.
On Windows, the drive is not reset when a rooted path segment (e.g.,
``r'\foo'``) is encountered. If a segment is on a different drive or is an
More information about the Python-checkins
mailing list