DEPRECATE typeRepKey
authorSimon Marlow <marlowsd@gmail.com>
Thu, 14 Jul 2011 14:51:40 +0000 (15:51 +0100)
committerSimon Marlow <marlowsd@gmail.com>
Mon, 18 Jul 2011 12:23:58 +0000 (13:23 +0100)
Data/Typeable.hs

index 8858ab5..07b2ce5 100644 (file)
@@ -131,15 +131,11 @@ import Array    ( Array )
 
 #include "Typeable.h"
 
--- | Returns a unique integer associated with a 'TypeRep'.  This can
--- be used for making a mapping with TypeReps
--- as the keys, for example.  It is guaranteed that @t1 == t2@ if and only if
--- @typeRepKey t1 == typeRepKey t2@.
---
--- It is in the 'IO' monad because the actual value of the key may
--- vary from run to run of the program.  You should only rely on
--- the equality property, not any actual key value.  The relative ordering
--- of keys has no meaning either.
+{-# DEPRECATED typeRepKey "TypeRep itself is now an instance of Ord" #-}
+-- | (DEPRECATED) Returns a unique key associated with a 'TypeRep'.
+-- This function is deprecated because 'TypeRep' itself is now an
+-- instance of 'Ord', so mappings can be made directly with 'TypeRep'
+-- as the key.
 --
 typeRepKey :: TypeRep -> IO TypeRepKey
 typeRepKey (TypeRep f _ _) = return (TypeRepKey f)