Why isn't HTML generated in some database modules?
There are several modules in base that have no documentation links. For example, GHC / Show.hs has eater comments, but there is no documentation for the module GHC.Show
in Hackage. Why not? This is mistake?
source to share
This is obviously intentional. This is the result of this line in GHC / Show.hs:
{-# OPTIONS_HADDOCK hide #-}
Relevant excerpts from the haddock documentation :
Each module can have some attributes that affect how Haddock generates documentation for that module. Attributes are specified in a comma-separated list in the pragma
{-# OPTIONS_HADDOCK ... #-}
at the top of the module, before or after the module description.[...]
Haddock currently understands the following attributes:
- hide
Omit this module from generated documentation, but nevertheless distribute the definitions and documentation from this module to modules that re-export those definitions.
[...]
source to share