Test.HUnit documentation

[guest]

I'd like to contribute Haddock documentation for HUnit.

Where there was documentation in comments in the original source code, I have generally used that - but it was mostly for the implementation of the text-based test runner, not the stuff that a typical library user would need for making assertions, constructing test cases etc. I've focused on the latter.

Afaik Haddock doesn't work with literate Haskell files, so I have converted to non-literate files. No code changes - just comments/docs.

[guest]

Darcs patch

[himself@…]

HTML docs produced by Haddock

[himself@…]

HTML docs produced by Haddock

[himself@…]

HTML docs produced by Haddock

[himself@…]

HTML docs produced by Haddock

[RichardG]

The patch from this ticket and documentation from another source were combined and uploaded to  http://code.haskell.org/HUnit.

While there might be some fine tuning left to do, the documentation is now in a much better state than in the stock 6.8.2 version. Unless there are major errors (e.g., parts of the documentation are wrong), I recommend that this ticket be closed and further issues and enhancements be handled through other tickets. Imperfect or, even, partial documentation is better than none.

[igloo]

Closing the ticket as suggested.

[RichardG]

Reopenening ticket; documentation didn't make it into library.

[RichardG]

Darcs patch

[RichardG]

FIX-1632-Test.HUnit-documentation.patch adds documentation to the Test.HUnit library. In addition to API documentation, it includes a quick overview of how to use the library (the original patch was rejected because it did not have this). The version was also bumped from 1.2.0.3 to 1.2.0.4.

It has been tested with GHC 6.10.1 on Mac OS X 10.5 (Intel), Ubuntu Linux 8.10, and Windows Vista.

There is a small issue with it: runghc Setup.hs test does not work on Windows; the test files need to be invoked manually. Another bug will be opened to deal with this.