mention explicitly that hIsEOF may block
authorSimon Marlow <simonmar@microsoft.com>
Wed, 20 Feb 2008 14:12:09 +0000 (14:12 +0000)
committerSimon Marlow <simonmar@microsoft.com>
Wed, 20 Feb 2008 14:12:09 +0000 (14:12 +0000)
GHC/Handle.hs

index e175b12..8a79efa 100644 (file)
@@ -1212,6 +1212,9 @@ hSetFileSize handle size =
 -- 'True' if no further input can be taken from @hdl@ or for a
 -- physical file, if the current I\/O position is equal to the length of
 -- the file.  Otherwise, it returns 'False'.
+--
+-- NOTE: 'hIsEOF' may block, because it is the same as calling
+-- 'hLookAhead' and checking for an EOF exception.
 
 hIsEOF :: Handle -> IO Bool
 hIsEOF handle =