#18389: Clarify that relpath does not access the file system.

Initial patch by Madison May.
This commit is contained in:
R David Murray 2013-07-12 17:43:11 -04:00
parent 577d4ff6e0
commit ce10fab9f6
1 changed files with 4 additions and 2 deletions

View File

@ -234,8 +234,10 @@ the :mod:`glob` module.)
.. function:: relpath(path, start=None)
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`.