]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
#6825: small correction to split() docs.
authorGeorg Brandl <georg@python.org>
Thu, 14 Oct 2010 06:46:08 +0000 (06:46 +0000)
committerGeorg Brandl <georg@python.org>
Thu, 14 Oct 2010 06:46:08 +0000 (06:46 +0000)
Doc/library/os.path.rst

index 92f48cfbd25fcaba292d235f39688bd262050bed..6dc82b60ea07cfeab4ea1f459efb175352b0dec9 100644 (file)
@@ -268,14 +268,14 @@ applications should use string objects to access all files.
 
 .. function:: split(path)
 
-   Split the pathname *path* into a pair, ``(head, tail)`` where *tail* is the last
-   pathname component and *head* is everything leading up to that.  The *tail* part
-   will never contain a slash; if *path* ends in a slash, *tail* will be empty.  If
-   there is no slash in *path*, *head* will be empty.  If *path* is empty, both
-   *head* and *tail* are empty.  Trailing slashes are stripped from *head* unless
-   it is the root (one or more slashes only).  In nearly all cases, ``join(head,
-   tail)`` equals *path* (the only exception being when there were multiple slashes
-   separating *head* from *tail*).
+   Split the pathname *path* into a pair, ``(head, tail)`` where *tail* is the
+   last pathname component and *head* is everything leading up to that.  The
+   *tail* part will never contain a slash; if *path* ends in a slash, *tail*
+   will be empty.  If there is no slash in *path*, *head* will be empty.  If
+   *path* is empty, both *head* and *tail* are empty.  Trailing slashes are
+   stripped from *head* unless it is the root (one or more slashes only).  In
+   all cases, ``join(head, tail)`` returns a path to the same location as *path*
+   (but the strings may differ).
 
 
 .. function:: splitdrive(path)