From: Skip Montanaro <skip@pobox.com>
Date: Wed, 23 Aug 2000 16:58:32 +0000 (+0000)
Subject: update commonprefix doc to make sure user is aware it works
X-Git-Tag: v2.0b1~297
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=297bf7ceb5d325ad300c5b7776856a6c8cce4c93;p=thirdparty%2FPython%2Fcpython.git

update commonprefix doc to make sure user is aware it works
character-by-character and that that behavior may result in it returning
prefixes that are not valid paths
---

diff --git a/Doc/lib/libposixpath.tex b/Doc/lib/libposixpath.tex
index 4981ac0cad90..66e278100c81 100644
--- a/Doc/lib/libposixpath.tex
+++ b/Doc/lib/libposixpath.tex
@@ -21,9 +21,11 @@ of the pair returned by \code{split(\var{path})}.
 \end{funcdesc}
 
 \begin{funcdesc}{commonprefix}{list}
-Return the longest string that is a prefix of all strings in
+Return the longest path prefix (taken character-by-character) that is a
+prefix of all paths in 
 \var{list}.  If \var{list} is empty, return the empty string
-(\code{''}).
+(\code{''}).  Note that this may return invalid paths because it works a
+character at a time.
 \end{funcdesc}
 
 \begin{funcdesc}{dirname}{path}