#13009: Hierarchical Module Structure for GHC -------------------------------------+------------------------------------- Reporter: hsyl20 | Owner: hsyl20 Type: task | Status: patch Priority: low | Milestone: Component: GHC API | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3647 Wiki Page: | ModuleDependencies/Hierarchical | -------------------------------------+------------------------------------- Comment (by bgamari):
but it is already hard to use haddock with GHC as not that many functions have haddock comments and you need to read the Notes in order to understand everything.
I would say that we should fix haddock comments in GHC. In addition maybe we could make haddock export Notes in the generated documentation.
I agree that we should fix GHC's use of Haddock comments. We've been saying for a long time that all new exported functions should have Haddock comments. We are much better about this than we used to be but there is still a long ways to go
(I have generated some graphs: http://hsyl20.fr/ghc_module_deps/).
Neat! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13009#comment:15 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler