diff options
author | Skip Montanaro <skip@pobox.com> | 2000-08-23 16:58:32 (GMT) |
---|---|---|
committer | Skip Montanaro <skip@pobox.com> | 2000-08-23 16:58:32 (GMT) |
commit | 297bf7ceb5d325ad300c5b7776856a6c8cce4c93 (patch) | |
tree | d427e1ef37c6a27285f85d3e02100e2f20412e67 | |
parent | 640f483c50da4a3b7c75a55ebe62dc77e919433a (diff) | |
download | cpython-297bf7ceb5d325ad300c5b7776856a6c8cce4c93.zip cpython-297bf7ceb5d325ad300c5b7776856a6c8cce4c93.tar.gz cpython-297bf7ceb5d325ad300c5b7776856a6c8cce4c93.tar.bz2 |
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
-rw-r--r-- | Doc/lib/libposixpath.tex | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/lib/libposixpath.tex b/Doc/lib/libposixpath.tex index 4981ac0..66e2781 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} |