]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
update commonprefix doc to make sure user is aware it works
authorSkip Montanaro <skip@pobox.com>
Wed, 23 Aug 2000 16:58:32 +0000 (16:58 +0000)
committerSkip Montanaro <skip@pobox.com>
Wed, 23 Aug 2000 16:58:32 +0000 (16:58 +0000)
character-by-character and that that behavior may result in it returning
prefixes that are not valid paths

Doc/lib/libposixpath.tex

index 4981ac0cad906a83e450462f4905b25a6fb75596..66e278100c81a4ace70a3eae66888c6cf1470980 100644 (file)
@@ -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}