But some of us would definitely find it amusing. Deniz Dogan wrote on 15.06.2009 16:53:

2009/6/15 minh thu :

...

2009/6/15 Uwe Schmidt :

...

Dear Haskellers,

who needs this kind of documentation?

http://hackage.haskell.org/packages/archive/tfp/0.2/doc/html/Types-Data-Num-...

isn't this a kind of spam? Hi,

This is Template Haskell generated code...

Cheers, Thu

Not only can this webpage potentially crash the visitor's browser, I also don't think anyone anywhere would find that piece of documentation useful.

...

who needs this kind of documentation?

http://hackage.haskell.org/packages/archive/tfp/0.2/doc/html/Types-Data-Num-...

The code below is shown under 'Source' links in that documentation. I don't understand it, but it seems everything is generated automatically. What should the author do to avoid those comments?

Older versions of haddock used to define a CPP constant that could be used to tweak the code for haddock. Since newer versions nominally support every feature that GHC supports, that CPP support was dropped. (a) it would be nice if haddock still identified itself via CPP, just like GHC does. Then users would at least have the option to work around current limitations / bugs in haddock, as well as present tweaked presentations of their interfaces. (b) it seems sensible for haddock to provide two options for handling template Haskell code: - document the TH code - document the code generated by TH In this case, the first option would seem more suited. Claus

module Types.Data.Num.Decimal.Literals where

import Types.Data.Num.Decimal.Literals.TH

import Types.Data.Num.Decimal.Digits import Types.Data.Num.Ops

$( decLiteralsD "D" "d" (-10000) (10000) )

--

_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

On Mon, 2009-06-15 at 06:49 -0700, Don Stewart wrote:

si:

...

Dear Haskellers,

who needs this kind of documentation?

http://hackage.haskell.org/packages/archive/tfp/0.2/doc/html/Types-Data-Num-...

isn't this a kind of spam?

Seems like a good case for the haddock -hide option.

Note that this can be added to the module itself: {-# OPTIONS_HADDOCK prune #-}

From the user guide[1]:

prune Omit definitions that have no documentation annotations from the generated documentation. hide Omit this module from the generated documentation, but nevertheless propagate definitions and documentation from within this module to modules that re-export those definitions. Duncan [1] http://haskell.org/haddock/doc/html/module-attributes.html