Proposal: require Haddock comment for every new top-level function and type in GHC source code

Iavor Diatchki iavor.diatchki at
Mon Jun 30 20:34:35 UTC 2014

I think that's a good idea, as long as we do enforce it as "social policy"
rather than a script.  In other words, we should encourage folks to add
comments documenting functions, but not necessarily require them
*everywhere*, and leave it

I also share Richard's concern about using Haddock notation, and the
possibility of introducing build-failures due to typos in the documentation.


On Mon, Jun 30, 2014 at 1:18 PM, Johan Tibell <johan.tibell at>

> Left hold off one more week to give more contributors a change to
> voice their thoughts. If no one protests I will announce the new
> policy next Monday. Sounds good?
> _______________________________________________
> ghc-devs mailing list
> ghc-devs at
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <>

More information about the ghc-devs mailing list