[project @ 2005-02-03 10:32:11 by ross]

[ghc-base.git] / GHC / Err.lhs

diff --git a/GHC/Err.lhs b/GHC/Err.lhs
index a44e1a5..85453aa 100644 (file)
--- a/GHC/Err.lhs
+++ b/GHC/Err.lhs
@@ -1,5 +1,5 @@
 \begin{code}
-{-# OPTIONS -fno-implicit-prelude #-}
+{-# OPTIONS_GHC -fno-implicit-prelude #-}
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  GHC.Err
@@ -19,6 +19,7 @@
 -- 
 -----------------------------------------------------------------------------
 
+-- #hide
 module GHC.Err 
        (
          irrefutPatError
@@ -52,12 +53,13 @@ import GHC.Exception
 %*********************************************************
 
 \begin{code}
--- error stops execution and displays an error message
+-- | 'error' stops execution and displays an error message.
 error :: String -> a
 error s = throw (ErrorCall s)
 
+-- | A special case of 'error'.
 -- It is expected that compilers will recognize this and insert error
--- messages which are more appropriate to the context in which undefined 
+-- messages which are more appropriate to the context in which 'undefined'
 -- appears. 
 
 undefined :: a