m (reordered sections, added "Installation")
Revision as of 12:16, 22 March 2009
1 What is DocTest
DocTest is a small program, that checks examples in Haskell source code comments. It is modeled after doctest for Python.
DocTest is available from Hackage. Install it by typing (on your Unix shell):
$ cabal install doctest
Bellow is a small Haskell module. The module contains source code comments. Those comments are examples from an interactive Haskell session and demonstrate how the module is used.
module Fib where -- Examples: -- -- > fib 10 -- 55 -- > fib 5 -- 5 fib 0 = 0 fib 1 = 1 fib n = fib (n - 1) + fib (n - 2)
With DocTest you may checks if the implementation satisfies the given examples, by typing (on your Unix shell):
$ doctest Fib.hs
Lines starting with
All comment lines following an expression denote the result of that expression. Result is defined by what an REPL(e.g. ghci) prints to
evaluating that expression.
DocTest development is in an early stage. My public git repository is at:
Patches are gladly welcome!