[Haskell-cafe] ANN: haddock-library 1.0.0

Mateusz Kowalczyk fuuzetsu at fuuzetsu.co.uk
Wed Jun 18 07:43:50 UTC 2014


haddock-library is a package aiming to provide bits of Haddock to the
rest of the Haskell world without imposing the GHC dependency that we
have on the ‘haddock’ package itself.

Please note that this does not deprecate the ‘haddock’ package which
aims to expose other bits of Haddock, including those talking with GHC.

Specifically, 1.0.0 exposes the types used by the comment parser and the
parser itself. This allows you to supply the Haddock parser with String
and get a Haddock ADT back out to play with. This means that if in the
past you were processing Haddock strings with your own solution (or copy
+ pasted Alex parser we had) then you should now switch to this package

The API is subject to change so upper version bound is advised. Tested
on 7.6.3, 7.8.x and current HEAD. The parser exposed is what is used in
Haddock itself which now internally depends on this package.

There are plans to move more parts into this package, exposing as much
useful functionality as possible without the GHC dependency.

New releases are independent of the GHC release cycle, unlike Haddock
itself. To file issues for this package, use the Haddock issue tracker
that's now on GitHub.

Mateusz K.

More information about the Haskell-Cafe mailing list