[Python-checkins] cpython (3.3): #18389: Clarify that relpath does not access the file system.

[r.david.murray]

http://hg.python.org/cpython/rev/70837970c5d8
changeset:   84599:70837970c5d8
branch:      3.3
parent:      84597:0ca31c07e85e
user:        R David Murray <rdmurray at bitdance.com>
date:        Fri Jul 12 17:43:11 2013 -0400
summary:
  #18389: Clarify that relpath does not access the file system.

Initial patch by Madison May.

files:
  Doc/library/os.path.rst |  6 ++++--
  1 files changed, 4 insertions(+), 2 deletions(-)


diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -234,8 +234,10 @@
 
 .. 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`.
 

-- 
Repository URL: http://hg.python.org/cpython