Fix documentation

2020-01-24 13:01:28 +01:00 · 2020-01-24 13:01:28 +01:00 · a6036a7aea
commit a6036a7aea
parent 0ff3808544
1 changed files with 2 additions and 1 deletions
--- a/hpath-filepath/src/System/Posix/FilePath.hs
+++ b/hpath-filepath/src/System/Posix/FilePath.hs
@ -727,7 +727,8 @@ makeValid path
  | otherwise    = BS.map (\x -> if x == _nul then _underscore else x) path


-- | Is a FilePath valid, i.e. could you create a file like it?
+-- | Whether the filename is a special directory entry
+-- (. and ..). Does not normalise filepaths.
 --
 -- >>> isSpecialDirectoryEntry "."
 -- True