#44, clarify that isValid doesn't check length limits
authorNeil Mitchell <ndmitchell@gmail.com>
Thu, 23 Apr 2015 19:53:39 +0000 (20:53 +0100)
committerNeil Mitchell <ndmitchell@gmail.com>
Thu, 23 Apr 2015 19:53:39 +0000 (20:53 +0100)
System/FilePath/Internal.hs

index 42bc19b..57355d1 100644 (file)
@@ -840,7 +840,9 @@ badElements :: [FilePath]
 badElements = ["CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9", "CLOCK$"]
 
 
--- | Is a FilePath valid, i.e. could you create a file like it?
+-- | Is a FilePath valid, i.e. could you create a file like it? This function checks for invalid names,
+--   and invalid characters, but does not check if length limits are exceeded, as these are typically
+--   filesystem dependent.
 --
 -- >          isValid "" == False
 -- >          isValid "\0" == False