summaryrefslogtreecommitdiffstats
path: root/Doc/library/os.path.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-07-12 21:43:11 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-07-12 21:43:11 (GMT)
commitce10fab9f6f1d42519cdeace6ba4bf9653ef2366 (patch)
treec7ec907521fff0800682b3cf5ce2e1521e109881 /Doc/library/os.path.rst
parent577d4ff6e0c08d6ebd50aa3b4390ede09451f1ba (diff)
downloadcpython-ce10fab9f6f1d42519cdeace6ba4bf9653ef2366.zip
cpython-ce10fab9f6f1d42519cdeace6ba4bf9653ef2366.tar.gz
cpython-ce10fab9f6f1d42519cdeace6ba4bf9653ef2366.tar.bz2
#18389: Clarify that relpath does not access the file system.
Initial patch by Madison May.
Diffstat (limited to 'Doc/library/os.path.rst')
-rw-r--r--Doc/library/os.path.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst
index dd3ac85..1d46bf2 100644
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -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`.