#4861: Documentation for base does not include special items
---------------------------------+------------------------------------------
Reporter: NeilMitchell | Owner:
Type: bug | Status: new
Priority: normal | Component: libraries/base
Version: 7.0.1 | Keywords:
Testcase: | Blockedby:
Os: Unknown/Multiple | Blocking:
Architecture: Unknown/Multiple | Failure: Documentation bug
---------------------------------+------------------------------------------
The documentation for base does not include tuples, lists or arrow. I
realise these are special in Haskell, but it seems a shame they aren't
documented.
For tuples, the documentation for base doesn't include them in either
Prelude or Data.Tuple, but the documentation for ghc-prim includes them in
GHC.Unit and GHC.Tuple. I think the lack of documentation for tuple types
is a bug, since it would be relatively easy for them to be documented, and
does make the documentation more complete.
For lists ([], (:)), there is no documentation in either base or ghc-prim.
It would be nice if they were documented in Prelude and Data.List, but not
if it was too much effort (I can imagine that Haddock can't accept list
definitions).
For the arrow type ->, it's unclear if it can reasonably be documented, so
it might be worth thinking about but probably not bothering to document.
The reason I'm interested in ensuring complete documentation is that
Hoogle currently doesn't know about tuple constructors in the base
library, but it does know about them in ghc-prim, which seems wrong.
--
Ticket URL: <http://hackage.haskell.org/trac/ghc/ticket/4861>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler
_______________________________________________
Glasgow-haskell-bugs mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
