summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-06-13 14:12:49 (GMT)
committerGitHub <noreply@github.com>2019-06-13 14:12:49 (GMT)
commitec3839a215a68cf35ff1f90cb6823f67a5abdce3 (patch)
treede97fffcb47630b91ca02542f546e12eb4643e60 /Doc
parentb4f5b212535e75503fc33513676837089037bb48 (diff)
downloadcpython-ec3839a215a68cf35ff1f90cb6823f67a5abdce3.zip
cpython-ec3839a215a68cf35ff1f90cb6823f67a5abdce3.tar.gz
cpython-ec3839a215a68cf35ff1f90cb6823f67a5abdce3.tar.bz2
bpo-6689: os.path.commonpath raises ValueError for different drives isn't documented (GH-14045)
It would raise ValueError("Paths don't have the same drive") if the paths on different drivers, which is not documented. os.path.commonpath raises ValueError when the *paths* are in different drivers, but it is not documented. Update the document according @Windsooon 's suggestion. It actually raise ValueError according line 355 of [test of path](https://github.com/python/cpython/blob/master/Lib/test/test_ntpath.py) https://bugs.python.org/issue6689 (cherry picked from commit 95492032c48fef20b9c7076a23fe7e46927a4688) Co-authored-by: Makdon <makdon@makdon.me>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/os.path.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst
index 8e7ee8b..a673b81 100644
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -87,9 +87,10 @@ the :mod:`glob` module.)
.. function:: commonpath(paths)
Return the longest common sub-path of each pathname in the sequence
- *paths*. Raise :exc:`ValueError` if *paths* contains both absolute and relative
- pathnames, or if *paths* is empty. Unlike :func:`commonprefix`, this
- returns a valid path.
+ *paths*. Raise :exc:`ValueError` if *paths* contain both absolute
+ and relative pathnames, the *paths* are on the different drives or
+ if *paths* is empty. Unlike :func:`commonprefix`, this returns a
+ valid path.
.. availability:: Unix, Windows.