summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-04-26 19:46:14 (GMT)
committerGitHub <noreply@github.com>2021-04-26 19:46:14 (GMT)
commitb570feaa9c6039b9d89cdf854a5fb388872eb38e (patch)
tree44fe5dc77fdcedbc2d5dc7d0ceb16f1a594f95bc
parent2760a6711b0f510afbd09b19949bee786e098af9 (diff)
downloadcpython-b570feaa9c6039b9d89cdf854a5fb388872eb38e.zip
cpython-b570feaa9c6039b9d89cdf854a5fb388872eb38e.tar.gz
cpython-b570feaa9c6039b9d89cdf854a5fb388872eb38e.tar.bz2
bpo-41661: Document os.path.relpath() exception on Windows with different drives (GH-25346) (#25367)
(cherry picked from commit 67c0b3d89c4da9750fdb43fc66d3924681b22d2e) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
-rw-r--r--Doc/library/os.path.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst
index 251df4d..d2fe494 100644
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -366,7 +366,8 @@ the :mod:`glob` module.)
Return a relative filepath to *path* either from the current directory or
from an optional *start* directory. This is a path computation: the
filesystem is not accessed to confirm the existence or nature of *path* or
- *start*.
+ *start*. On Windows, :exc:`ValueError` is raised when *path* and *start*
+ are on different drives.
*start* defaults to :attr:`os.curdir`.