[Haskell-cafe] Best practices for modular programming in Haskell

Simon Marlow simonmar at microsoft.com
Thu Mar 17 10:54:53 EST 2005

On 17 March 2005 06:11, Sean Perry wrote:

> Benjamin Pierce wrote:
>> Other people seem to rely on Haddock to generate interfaces as
>> documentation.  This is nicer in many ways (e.g., it solves the above
>> problem because Haddock elides the right-hand side of a "data" or
>> "newtype" declaration if the constructors are not exported by the
>> module), but it means that you are stuck browsing interfaces in a
>> web browser can't just have a look with emacs.  This is especially
>> annoying if you want to read the interface in tandem with the
>> implementation (because you are trying to understand how the thing
>> works internally but want to use the interface to get a high-level
>> picture of the functionality it presents to the world). 
> haddock can also output docbook and you can make info pages from
> docbook.

Actually the DocBook backend isn't really there yet.

It wouldn't be too hard to add a plain ASCII backend to Haddock that
generates the interfaces for modules without the implementation - that
would address Benjamin's concern to some extent.


More information about the Haskell-Cafe mailing list