Version 35 (modified by SimonHengel, 5 months ago)

--

The Haddock Development Wiki and Bug Tracker

Haddock is a tool for automatically generating documentation from annotated Haskell source code. This is its developer wiki and bug tracker. If you want to help out by adding information to the wiki, or by sending bug reports or requests requests, just register an account and edit away!

Offical Source Code Repository

Haddock's git repository is at:

git://git.haskell.org/haddock

Development happens on master and you need GHC HEAD for development.

We are on IRC!

Join #haddock on freenode!

Development Topics

Contributing

All new code needs tests. Currently we manly use golden tests for testing Haddock (see tests/html-tests/). We also have some unit tests (see tests/unit-tests/), in the future we want more of those.

State clearly what the purpose/scope of a test is. For historical reasons, not all existing tests do so. But it is mandatory for new tests. Here are some examples:

Links