[Haskell-cafe] Re: Haddock: Documentation of instances
with un-documentable type arguments
waldmann at imn.htwk-leipzig.de
Sat Aug 28 07:33:43 EDT 2010
> > Perhaps Haddock could exclude class instance reporting when it cannot find a
> > documentable link to a parameter?
The "cannot find documentable link" problem also comes up
in situations like this (that don't involve type classes):
module Ex ( foo ) where
data Secret = Secret
foo = Secret
Should haddock generate documentation
for foo (since it is exported)
or not (since its result type is not exported)?
Now imagine something like "instance Show Secret"
(inside the Ex module).
The user of the module then can write "show foo",
and so it should be documented?
More information about the Haskell-Cafe