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
This commit is contained in:
Skip Montanaro 2000-08-23 16:58:32 +00:00
parent 640f483c50
commit 297bf7ceb5
1 changed files with 4 additions and 2 deletions

View 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}