[commit: packages/base] master: Comments only. (5edb063)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/base

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/5edb063688e73ec00fd1f61ac0e8317dd122f44a/base

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

commit 5edb063688e73ec00fd1f61ac0e8317dd122f44a
Author: Iavor S. Diatchki <iavor.diatchki at gmail.com>
Date:   Sun Mar 23 17:10:38 2014 -0700

    Comments only.
    
    Fix the documentation on CmpSymbol and CmpNat; add a note on (<=?).


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

5edb063688e73ec00fd1f61ac0e8317dd122f44a
 GHC/TypeLits.hs |    9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/GHC/TypeLits.hs b/GHC/TypeLits.hs
index ac0f1ae..4a6c7b9 100644
--- a/GHC/TypeLits.hs
+++ b/GHC/TypeLits.hs
@@ -153,13 +153,16 @@ infixr 8 ^
 -- | Comparison of type-level naturals, as a constraint.
 type x <= y = (x <=? y) ~ True
 
--- | Comparison of type-level naturals, as a function.
+-- | Comparison of type-level symbols, as a function.
 type family CmpSymbol (m :: Symbol) (n :: Symbol) :: Ordering
 
--- | Comparison of type-level symbols, as a function.
+-- | Comparison of type-level naturals, as a function.
 type family CmpNat    (m :: Nat)    (n :: Nat)    :: Ordering
 
--- | Comparison of type-level naturals, as a function.
+{- | Comparison of type-level naturals, as a function.
+NOTE: The functionality for this function should be subsumed
+by 'CmpNat', so this might go away in the future.
+Please let us know, if you encounter discrepancies between the two. -}
 type family (m :: Nat) <=? (n :: Nat) :: Bool
 
 -- | Addition of type-level naturals.