[commit: base] master: DEPRECATE typeRepKey (77c2f49)

[Simon Marlow]

Repository : ssh://darcs.haskell.org//srv/darcs/packages/base

On branch  : master

http://hackage.haskell.org/trac/ghc/changeset/77c2f494098f66bc44639ab7fcf84c095c769f82

>---------------------------------------------------------------

commit 77c2f494098f66bc44639ab7fcf84c095c769f82
Author: Simon Marlow <marlowsd at gmail.com>
Date:   Thu Jul 14 15:51:40 2011 +0100

    DEPRECATE typeRepKey

>---------------------------------------------------------------

 Data/Typeable.hs |   14 +++++---------
 1 files changed, 5 insertions(+), 9 deletions(-)

diff --git a/Data/Typeable.hs b/Data/Typeable.hs
index 8858ab5..07b2ce5 100644
--- a/Data/Typeable.hs
+++ b/Data/Typeable.hs
@@ -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 at .

>---------------------------------------------------------------

--- 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)