Describe avoided pitfall in new code

commercialhaskell · Aug 14, 2016 · 3e69d2a · 3e69d2a
1 parent 19cf0a1
commit 3e69d2a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/Data/Yaml/Extra.hs b/src/Data/Yaml/Extra.hs
@@ -8,6 +8,8 @@ import           Data.Yaml hiding (decodeFileEither, encodeFile)
 import qualified Data.ByteString as B
 import           System.IO
 
+-- Note: we refrain from using 'B.readFile' and 'B.writeFile', as they open
+-- the file in binary mode rather than text mode.
 decodeFileEither :: FromJSON a => FilePath -> IO (Either ParseException a)
 decodeFileEither path = withFile path ReadMode $
   \hnd -> do