[commit: base] master: Remove commented types in module export lists (fff940b)

[Ian Lynagh]

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

On branch  : master

http://hackage.haskell.org/trac/ghc/changeset/fff940b16ba589380c7fc538bfccd0094c97583b

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

commit fff940b16ba589380c7fc538bfccd0094c97583b
Author: Ian Lynagh <ian at well-typed.com>
Date:   Sat Oct 27 19:13:27 2012 +0100

    Remove commented types in module export lists
    
    These comments are rather less useful now that haddock can give docs
    with the same informatino in the module synopsis.
    
    Having to maintain them when making changes to the library is a pain,
    and when people forget about doing so there is nothing that checks that
    the comments are right, so mistakes tend to linger.
    
    Of the comments that my script detected, 78 of 684 were already
    incorrect in one way or another, e.g. missing context:
        Text.Show.showsPrec
        Comment type: Int -> a -> ShowS
        Actual type:  Show a => Int -> a -> ShowS
    wrong context:
        Numeric.readInt
        Comment type: Integral a => a -> (Char -> Bool) -> (Char -> Int) -> ReadS a
        Actual type:  Num a => a -> (Char -> Bool) -> (Char -> Int) -> ReadS a
    not following a class change (e.g. Num losing its Eq superclass):
        Text.Read.Lex.readOctP
        Comment type: Num a => ReadP a
        Actual type:  (Eq a, Num a) => ReadP a
    not following the Exceptions change:
        GHC.Conc.childHandler
        Comment type: Exception -> IO ()
        Actual type:  SomeException -> IO ()
    or just always been wrong:
        GHC.Stable.deRefStablePtr
        Comment type: StablePtr a -> a
        Actual type:  StablePtr a -> IO a

 Control/Concurrent.hs              |    8 +-
 Control/Concurrent/Chan.hs         |   16 ++--
 Control/Concurrent/MVar.hs         |    2 +-
 Control/Monad.hs                   |   66 ++++++------
 Control/Monad/Fix.hs               |    6 +-
 Control/Monad/ST.hs                |    6 +-
 Control/Monad/ST/Imp.hs            |   12 +-
 Control/Monad/ST/Safe.hs           |    8 +-
 Data/Bits.hs                       |   32 +++---
 Data/Bool.hs                       |    8 +-
 Data/Char.hs                       |   16 ++--
 Data/Complex.hs                    |   25 ++---
 Data/Data.hs                       |   76 +++++++-------
 Data/Dynamic.hs                    |    6 +-
 Data/Either.hs                     |    8 +-
 Data/IORef.hs                      |   16 ++--
 Data/Ix.hs                         |    8 +-
 Data/List.hs                       |  194 ++++++++++++++++++------------------
 Data/Maybe.hs                      |   25 ++---
 Data/Ratio.hs                      |   19 +---
 Data/STRef.hs                      |   12 +-
 Data/STRef/Lazy.hs                 |   10 +-
 Data/Tuple.hs                      |   10 +-
 Data/Typeable.hs                   |   64 ++++++------
 Data/Unique.hs                     |    6 +-
 Debug/Trace.hs                     |    4 +-
 Foreign/C/Error.hs                 |   39 +++-----
 Foreign/C/String.hs                |   58 ++++++------
 Foreign/Marshal/Alloc.hs           |   18 ++--
 Foreign/Marshal/Array.hs           |   40 ++++----
 Foreign/Marshal/Error.hs           |   14 +--
 Foreign/Marshal/Pool.hs            |   28 +++---
 Foreign/Marshal/Utils.hs           |   23 ++---
 Foreign/Ptr.hs                     |   24 ++--
 Foreign/StablePtr.hs               |   10 +-
 Foreign/Storable.hs                |   16 ++--
 GHC/Conc.lhs                       |   84 ++++++++--------
 GHC/Conc/IO.hs                     |   20 ++--
 GHC/Conc/Sync.lhs                  |   64 ++++++------
 GHC/Conc/Windows.hs                |   10 +-
 GHC/Err.lhs                        |   12 +-
 GHC/Foreign.hs                     |   14 ++--
 GHC/MVar.hs                        |   16 ++--
 GHC/Pack.lhs                       |    6 +-
 GHC/Read.lhs                       |   20 ++--
 GHC/Stable.lhs                     |   10 +-
 Numeric.hs                         |   37 ++++----
 System/Environment.hs              |   10 +-
 System/Exit.hs                     |    6 +-
 System/IO.hs                       |  108 ++++++++++----------
 System/IO/Error.hs                 |   46 ++++-----
 System/IO/Unsafe.hs                |    6 +-
 System/Info.hs                     |    8 +-
 System/Mem.hs                      |    2 +-
 System/Mem/Weak.hs                 |   14 ++--
 Text/ParserCombinators/ReadP.hs    |   72 +++++++-------
 Text/ParserCombinators/ReadPrec.hs |   34 +++---
 Text/Read.hs                       |   24 ++--
 Text/Read/Lex.hs                   |   16 ++--
 Text/Show.hs                       |   18 ++--
 60 files changed, 771 insertions(+), 819 deletions(-)


Diff suppressed because of size. To see it, use:

    git show fff940b16ba589380c7fc538bfccd0094c97583b