summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-02-03 19:24:44 (GMT)
committerFred Drake <fdrake@acm.org>1999-02-03 19:24:44 (GMT)
commit0256c1f453c1b2689858f9774068d3908b87cd8a (patch)
treed3df33554e9b0f04b87001064737a4a09f1b5dd0 /Doc
parentead9d8d2d75b7af242aaf44ad6cb2836fff8b57f (diff)
downloadcpython-0256c1f453c1b2689858f9774068d3908b87cd8a.zip
cpython-0256c1f453c1b2689858f9774068d3908b87cd8a.tar.gz
cpython-0256c1f453c1b2689858f9774068d3908b87cd8a.tar.bz2
Document splitdrive().
For all split*(), these split path *into* pairs, not split path *in* pairs. "Into" can be used for transformations, "in" is for containment.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libposixpath.tex12
1 files changed, 10 insertions, 2 deletions
diff --git a/Doc/lib/libposixpath.tex b/Doc/lib/libposixpath.tex
index f128be7..763dd35 100644
--- a/Doc/lib/libposixpath.tex
+++ b/Doc/lib/libposixpath.tex
@@ -138,7 +138,7 @@ fails.
\end{funcdesc}
\begin{funcdesc}{split}{path}
-Split the pathname \var{path} in a pair \code{(\var{head},
+Split the pathname \var{path} into a pair \code{(\var{head},
\var{tail})}, where \var{tail} is the last pathname component and
\var{head} is everything leading up to that. The \var{tail} part will
never contain a slash; if \var{path} ends in a slash, \var{tail} will
@@ -151,8 +151,16 @@ exception being when there were multiple slashes separating \var{head}
from \var{tail}).
\end{funcdesc}
+\begin{funcdesc}{splitdrive}{path}
+Split the pathname \var{path} into a pair \code{(\var{drive},
+\var{tail})}, where \var{drive} is either a drive specification or the
+empty string. On systems which do not use drive specifications,
+\var{drive} will always be the empty string. In all cases,
+\code{\var{drive} + \var{tail}} will be the same as \var{path}.
+\end{funcdesc}
+
\begin{funcdesc}{splitext}{path}
-Split the pathname \var{path} in a pair \code{(\var{root}, \var{ext})}
+Split the pathname \var{path} into a pair \code{(\var{root}, \var{ext})}
such that \code{\var{root} + \var{ext} == \var{path}},
and \var{ext} is empty or begins with a period and contains
at most one period.