Remove commented types in module export lists
authorIan Lynagh <ian@well-typed.com>
Sat, 27 Oct 2012 18:13:27 +0000 (19:13 +0100)
committerIan Lynagh <ian@well-typed.com>
Sat, 27 Oct 2012 18:13:27 +0000 (19:13 +0100)
commitfda30027384069e79df15a7674707a73e56288ed
treeac2cf3a0624ebd0df36755a0757f9f41fcb9b7c8
parent57f65911762147ae20af7e41166597e9f0c34ec8
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
60 files changed:
libraries/base/Control/Concurrent.hs
libraries/base/Control/Concurrent/Chan.hs
libraries/base/Control/Concurrent/MVar.hs
libraries/base/Control/Monad.hs
libraries/base/Control/Monad/Fix.hs
libraries/base/Control/Monad/ST.hs
libraries/base/Control/Monad/ST/Imp.hs
libraries/base/Control/Monad/ST/Safe.hs
libraries/base/Data/Bits.hs
libraries/base/Data/Bool.hs
libraries/base/Data/Char.hs
libraries/base/Data/Complex.hs
libraries/base/Data/Data.hs
libraries/base/Data/Dynamic.hs
libraries/base/Data/Either.hs
libraries/base/Data/IORef.hs
libraries/base/Data/Ix.hs
libraries/base/Data/List.hs
libraries/base/Data/Maybe.hs
libraries/base/Data/Ratio.hs
libraries/base/Data/STRef.hs
libraries/base/Data/STRef/Lazy.hs
libraries/base/Data/Tuple.hs
libraries/base/Data/Typeable.hs
libraries/base/Data/Unique.hs
libraries/base/Debug/Trace.hs
libraries/base/Foreign/C/Error.hs
libraries/base/Foreign/C/String.hs
libraries/base/Foreign/Marshal/Alloc.hs
libraries/base/Foreign/Marshal/Array.hs
libraries/base/Foreign/Marshal/Error.hs
libraries/base/Foreign/Marshal/Pool.hs
libraries/base/Foreign/Marshal/Utils.hs
libraries/base/Foreign/Ptr.hs
libraries/base/Foreign/StablePtr.hs
libraries/base/Foreign/Storable.hs
libraries/base/GHC/Conc.lhs
libraries/base/GHC/Conc/IO.hs
libraries/base/GHC/Conc/Sync.lhs
libraries/base/GHC/Conc/Windows.hs
libraries/base/GHC/Err.lhs
libraries/base/GHC/Foreign.hs
libraries/base/GHC/MVar.hs
libraries/base/GHC/Pack.lhs
libraries/base/GHC/Read.lhs
libraries/base/GHC/Stable.lhs
libraries/base/Numeric.hs
libraries/base/System/Environment.hs
libraries/base/System/Exit.hs
libraries/base/System/IO.hs
libraries/base/System/IO/Error.hs
libraries/base/System/IO/Unsafe.hs
libraries/base/System/Info.hs
libraries/base/System/Mem.hs
libraries/base/System/Mem/Weak.hs
libraries/base/Text/ParserCombinators/ReadP.hs
libraries/base/Text/ParserCombinators/ReadPrec.hs
libraries/base/Text/Read.hs
libraries/base/Text/Read/Lex.hs
libraries/base/Text/Show.hs