Scrap your boilerplate (but don't scrap them precious comments)

Simon Marlow simonmar at
Tue Mar 1 07:26:08 EST 2005

On 01 March 2005 10:43, Ross Paterson wrote:

> On Tue, Mar 01, 2005 at 09:42:17AM -0000, Simon Marlow wrote:
>> One thing I'm going to do for the 6.4 docs is include a link to the
>> source code file (pointing to for each module.
> Of course this won't work when the exported names are defined
> elsewhere. But I also think it would be going too far: it will
> encourage users 
> to refer to the source code as the true documentation in all cases,
> leading to both reliance on accidental features and reduced demand for
> better interface documentation.

That's true.  I also discovered that adding the source code links isn't
as easy as I thought, so it won't happen anyway.


More information about the Glasgow-haskell-users mailing list