From: Georg Brandl <georg@python.org>
Date: Wed, 14 Sep 2005 20:42:00 +0000 (+0000)
Subject: bug [ 1274828 ] splitunc not documented
X-Git-Tag: v2.5a0~1378
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3225242a39bef1a9f759867518981f512c2d61f3;p=python

bug [ 1274828 ] splitunc not documented
---

diff --git a/Doc/lib/libposixpath.tex b/Doc/lib/libposixpath.tex
index 59944f8849..190cf07dc1 100644
--- a/Doc/lib/libposixpath.tex
+++ b/Doc/lib/libposixpath.tex
@@ -234,6 +234,15 @@ and \var{ext} is empty or begins with a period and contains
 at most one period.
 \end{funcdesc}
 
+\begin{funcdesc}{splitunc}{path}
+Split the pathname \var{path} into a pair \code{(\var{unc}, \var{rest})}
+so that \var{unc} is the UNC mount point (such as \code{r'\e\e host\e mount'}),
+if present, and \var{rest} the rest of the path (such as 
+\code{r'\e path\e file.ext'}).  For paths containing drive letters, \var{unc}
+will always be the empty string.
+Availability:  Windows.
+\end{funcdesc}
+
 \begin{funcdesc}{walk}{path, visit, arg}
 Calls the function \var{visit} with arguments
 \code{(\var{arg}, \var{dirname}, \var{names})} for each directory in the
diff --git a/Misc/NEWS b/Misc/NEWS
index 45e7007c22..855a95cde2 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -512,6 +512,8 @@ Tests
 Documentation
 -------------
 
+- Bug #1274828: Document os.path.splitunc().
+
 - Bug #1190204: Clarify which directories are searched by site.py.
 
 - Bug #1193849: Clarify os.path.expanduser() documentation.