Possible Haddock bug affecting GHC docs
Krzysztof Skrzętnicki
gtener at gmail.com
Sun Dec 21 19:47:59 EST 2008
Hello everyone
Please visit these to pages:
http://www.haskell.org/ghc/docs/6.8.3/html/libraries/haskell98/CTypes.html
-- ver 0.9
http://www.haskell.org/ghc/docs/6.10.1/html/libraries/haskell98/CTypes.html
-- ver 2.3.0
They show documentation produced by Haddock.
The problem is: on the second page (for GHC 6.10.1) there is no
information about exported module:
> module CTypes (module Foreign.C.Types) where
> import Foreign.C.Types
It seems it has something to do with bug fixed by 2.3.0 version of
Haddock: (see http://haskell.org/haddock/CHANGES.txt )
> Changed in version 2.3.0:
> (...)
> * Fix a bug that made hidden modules show up in the contents & index pages
> (...)
This is really annoying, especially that documentation on page doesn't
contain links for source code. I think this should be fixed too.
I also checked that information about exported modules appears when
there is more thing to export like in Control.Concurrent.
I didn't file a Haddock bug since I failed to make minimal example
that reproduces the bug.
A.hs:
> module A (module B) where
>
> import B
B.hs:
> module B (one,two) where
>
> one :: Int
> one = 1
>
> two :: Int
> two = 2
Turns out to generate good documentation. Perhaps there is something
more to be done to actually trigger the bug.
I attach my testing suite (A.hs, B.hs, Makefile, results).
All best
Christopher Skrzętnicki
-------------- next part --------------
A non-text attachment was scrubbed...
Name: haddock-bug.7z
Type: application/octet-stream
Size: 4445 bytes
Desc: not available
Url : http://www.haskell.org/pipermail/glasgow-haskell-users/attachments/20081222/7a658207/haddock-bug.obj
More information about the Glasgow-haskell-users
mailing list