From: Simon Marlow <marlowsd@gmail.com>
Date: Tue, 29 Jun 2010 13:39:16 +0000 (+0000)
Subject: re-instate the documentation for 'Char', which got lost at some point
X-Git-Tag: Haskell_2010_report_generated^0
X-Git-Url: http://git.megacz.com/?p=ghc-prim.git;a=commitdiff_plain;h=47b0aefd1330d5fcb1e81bf613223e3482d7bbc7

re-instate the documentation for 'Char', which got lost at some point
---

diff --git a/GHC/Types.hs b/GHC/Types.hs
index 8e3e71a..b2d0291 100644
--- a/GHC/Types.hs
+++ b/GHC/Types.hs
@@ -26,6 +26,18 @@ infixr 5 :
 
 data [] a = [] | a : [a]
 
+{-| The character type 'Char' is an enumeration whose values represent
+Unicode (or equivalently ISO\/IEC 10646) characters
+(see <http://www.unicode.org/> for details).
+This set extends the ISO 8859-1 (Latin-1) character set
+(the first 256 charachers), which is itself an extension of the ASCII
+character set (the first 128 characters).
+A character literal in Haskell has type 'Char'.
+
+To convert a 'Char' to or from the corresponding 'Int' value defined
+by Unicode, use 'Prelude.toEnum' and 'Prelude.fromEnum' from the
+'Prelude.Enum' class respectively (or equivalently 'ord' and 'chr').
+-}
 data Char = C# Char#
 
 data Int = I# Int#