summaryrefslogtreecommitdiffstats
path: root/Doc/libppath.tex
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>1997-02-18 21:53:53 (GMT)
committerBarry Warsaw <barry@python.org>1997-02-18 21:53:53 (GMT)
commit7574587587eb865f6beabf27d67e867a0fb5a4b5 (patch)
treef127084d44eac20d2b67a92cd088b8734a27d118 /Doc/libppath.tex
parentfbd64c8790e2cec2d6bc44d3d13f39b9a5940e12 (diff)
downloadcpython-7574587587eb865f6beabf27d67e867a0fb5a4b5.zip
cpython-7574587587eb865f6beabf27d67e867a0fb5a4b5.tar.gz
cpython-7574587587eb865f6beabf27d67e867a0fb5a4b5.tar.bz2
Document the new join() semantics.
Diffstat (limited to 'Doc/libppath.tex')
-rw-r--r--Doc/libppath.tex22
1 files changed, 6 insertions, 16 deletions
diff --git a/Doc/libppath.tex b/Doc/libppath.tex
index d43d3e1..7aec4b8 100644
--- a/Doc/libppath.tex
+++ b/Doc/libppath.tex
@@ -79,22 +79,12 @@ different device than \var{p}, or whether \file{\var{p}/..} and
detect mount points for all \UNIX{} and POSIX variants.
\end{funcdesc}
-\begin{funcdesc}{join}{p\, q}
-Join the paths
-\var{p}
-and
-\var{q} intelligently:
-If
-\var{q}
-is an absolute path, the return value is
-\var{q}.
-Otherwise, the concatenation of
-\var{p}
-and
-\var{q}
-is returned, with a slash (\code{'/'}) inserted unless
-\var{p}
-is empty or ends in a slash.
+\begin{funcdesc}{join}{p\optional{\, q\optional{\, ...}}}
+Joins one or more path components intelligently. If any component is
+an absolute path, all previous components are thrown away, and joining
+continues. The return value is the concatenation of \var{p}, and
+optionally \var{q}, etc., with exactly one slash (\code{'/'}) inserted
+between components, unless \var{p} is empty.
\end{funcdesc}
\begin{funcdesc}{normcase}{p}