From: Simon Marlow <marlowsd@gmail.com>
Date: Fri, 1 Apr 2011 11:15:50 +0000 (+0100)
Subject: Improve docs for GHC.IO.FD.openFile
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=57b9366e5fd3db86719d12b45320e6145b040fa6;p=ghc-base.git

Improve docs for GHC.IO.FD.openFile
---

diff --git a/GHC/IO/FD.hs b/GHC/IO/FD.hs
index 012bb73..1730885 100644
--- a/GHC/IO/FD.hs
+++ b/GHC/IO/FD.hs
@@ -139,9 +139,13 @@ writeBuf' fd buf = do
 -- opening files
 
 -- | Open a file and make an 'FD' for it.  Truncates the file to zero
--- size when the `IOMode` is `WriteMode`.  Puts the file descriptor
--- into non-blocking mode on Unix systems.
-openFile :: FilePath -> IOMode -> Bool -> IO (FD,IODeviceType)
+-- size when the `IOMode` is `WriteMode`.
+openFile
+  :: FilePath -- ^ file to open
+  -> IOMode   -- ^ mode in which to open the file
+  -> Bool     -- ^ open the file in non-blocking mode?
+  -> IO (FD,IODeviceType)
+
 openFile filepath iomode non_blocking =
   withFilePath filepath $ \ f ->