From a6036a7aea8c101dce094b823dcf227bccf9ca92 Mon Sep 17 00:00:00 2001
From: Julian Ospald <hasufell@posteo.de>
Date: Fri, 24 Jan 2020 13:01:28 +0100
Subject: [PATCH] Fix documentation

---
 hpath-filepath/src/System/Posix/FilePath.hs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/hpath-filepath/src/System/Posix/FilePath.hs b/hpath-filepath/src/System/Posix/FilePath.hs
index 1927d4c..cc9d27e 100644
--- 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