Merge pull request #10389 from MercuryTechnologies/wiggles/fix-withfi…

…lecontents-comment Fix `withFileContents` documentation (lazy IO strikes again)
haskell · Sep 30, 2024 · 6d25218 · 6d25218
2 parents 4e194c6 + 76d5f2f
commit 6d25218
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/Cabal-syntax/src/Distribution/Utils/Generic.hs b/Cabal-syntax/src/Distribution/Utils/Generic.hs
@@ -153,8 +153,8 @@ wrapLine width = wrap 0 []
 
 -- | Gets the contents of a file, but guarantee that it gets closed.
 --
--- The file is read lazily but if it is not fully consumed by the action then
--- the remaining input is truncated and the file is closed.
+-- The file is read lazily; if it is not fully consumed by the action then an
+-- exception is thrown.
 withFileContents :: FilePath -> (String -> IO a) -> IO a
 withFileContents name action =
   withFile