summaryrefslogtreecommitdiff
path: root/libraries/base/System/Environment.hs
diff options
context:
space:
mode:
authorross <unknown>2003-08-30 22:55:42 +0000
committerross <unknown>2003-08-30 22:55:42 +0000
commit0522e141d5d3d1d59634233fefc10c29ed43dace (patch)
tree9876fd94ef898f18eb295abdd59c2cbfd0a7621e /libraries/base/System/Environment.hs
parent59ad9e96a86ef75b4e86781e6e784e76f26e5670 (diff)
downloadhaskell-0522e141d5d3d1d59634233fefc10c29ed43dace.tar.gz
[project @ 2003-08-30 22:55:42 by ross]
docs for System.Environment & System.Exit
Diffstat (limited to 'libraries/base/System/Environment.hs')
-rw-r--r--libraries/base/System/Environment.hs14
1 files changed, 8 insertions, 6 deletions
diff --git a/libraries/base/System/Environment.hs b/libraries/base/System/Environment.hs
index 31f676572f..a0761d5995 100644
--- a/libraries/base/System/Environment.hs
+++ b/libraries/base/System/Environment.hs
@@ -51,7 +51,7 @@ import System
-- ---------------------------------------------------------------------------
-- getArgs, getProgName, getEnv
--- Computation `getArgs' returns a list of the program's command
+-- | Computation 'getArgs' returns a list of the program's command
-- line arguments (not including the program name).
#ifdef __GLASGOW_HASKELL__
@@ -107,11 +107,13 @@ unpackProgName argv = do
isPathSeparator _ = False
--- Computation `getEnv var' returns the value
--- of the environment variable {\em var}.
-
--- This computation may fail with
--- NoSuchThing: The environment variable does not exist.
+-- | Computation 'getEnv' @var@ returns the value
+-- of the environment variable @var@.
+--
+-- This computation may fail with:
+--
+-- * 'System.IO.Error.isDoesNotExistError' if the environment variable
+-- does not exist.
getEnv :: String -> IO String
getEnv name =