System.Posix.Temp: improve haddocks for mkstemp to explain what that returned String...
authorgwern0@gmail.com <unknown>
Tue, 19 Jan 2010 00:27:55 +0000 (00:27 +0000)
committergwern0@gmail.com <unknown>
Tue, 19 Jan 2010 00:27:55 +0000 (00:27 +0000)
System/Posix/Temp.hsc

index 0c9d436..824f917 100644 (file)
@@ -33,9 +33,10 @@ import System.Posix.Types
 import Foreign.C
 
 -- |'mkstemp' - make a unique filename and open it for
--- reading\/writing (only safe on GHC & Hugs)
-
-mkstemp :: String -> IO (String, Handle)
+-- reading\/writing (only safe on GHC & Hugs).
+-- The returned 'FilePath' is the (possibly relative) path of
+-- the created file.
+mkstemp :: String -> IO (FilePath, Handle)
 mkstemp template = do
 #if defined(__GLASGOW_HASKELL__) || defined(__HUGS__)
   withCString template $ \ ptr -> do