]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
#18389: Clarify that relpath does not access the file system.
authorR David Murray <rdmurray@bitdance.com>
Fri, 12 Jul 2013 22:21:41 +0000 (18:21 -0400)
committerR David Murray <rdmurray@bitdance.com>
Fri, 12 Jul 2013 22:21:41 +0000 (18:21 -0400)
Initial patch by Madison May.

Doc/library/os.path.rst

index 5e245d0df5ba49ea73ac7ae77c587edda81112e5..c84aaf29e1016e87ae9a4ae5fa0b3f91bf83b255 100644 (file)
@@ -236,8 +236,10 @@ the :mod:`glob` module.)
 
 .. function:: relpath(path[, start])
 
-   Return a relative filepath to *path* either from the current directory or from
-   an optional *start* point.
+   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* defaults to :attr:`os.curdir`.