aboutsummaryrefslogtreecommitdiffhomepage
path: root/System/Posix/Temp.hsc
diff options
context:
space:
mode:
authorGravatar gwern0@gmail.com <unknown>2010-01-19 00:27:55 +0000
committerGravatar gwern0@gmail.com <unknown>2010-01-19 00:27:55 +0000
commit93ed89887d5d762b06020ce6cd85ad7e7f9701d9 (patch)
tree6248e64e3dc6a5ee242bb067d63199f3074e0067 /System/Posix/Temp.hsc
parentcfe4a1e942390c90a167738d5aecac2d65c0d538 (diff)
System.Posix.Temp: improve haddocks for mkstemp to explain what that returned String actually is
Diffstat (limited to 'System/Posix/Temp.hsc')
-rw-r--r--System/Posix/Temp.hsc7
1 files changed, 4 insertions, 3 deletions
diff --git a/System/Posix/Temp.hsc b/System/Posix/Temp.hsc
index 0c9d436..824f917 100644
--- a/System/Posix/Temp.hsc
+++ b/System/Posix/Temp.hsc
@@ -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