Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An implementation of Python's doctest for Haskell
Haskell Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bash_completion.d
src
tests
.gitignore
KNOWN_ISSUES
LICENSE
README.markdown
Setup.lhs
doctest.cabal

README.markdown

What is doctest

doctest is a small program, that checks examples in Haddock comments. It is modeled after doctest for Python.

Installation

doctest is available from Hackage. Install it, by typing:

cabal install doctest

Usage

Below is a small Haskell module. The module contains a Haddock comment with some examples of interaction. The examples demonstrate how the module is supposed to be used.

module Fib where

-- | Compute Fibonacci numbers
--
-- Examples:
--
-- >>> fib 10
-- 55
--
-- >>> fib 5
-- 5
fib :: Int -> Int
fib 0 = 0
fib 1 = 1
fib n = fib (n - 1) + fib (n - 2)

(A comment line starting with >>> denotes an expression. All comment lines following an expression denote the result of that expression. Result is defined by what an REPL (e.g. ghci) prints to stdout and stderr when evaluating that expression.)

With doctest you may check whether the implementation satisfies the given examples, by typing:

doctest Fib.hs

You may produce Haddock documentation for that module with:

haddock -h Fib.hs -o doc/

Hacking

doctest is still experimental. Patches are gladly welcome!

Contributors (in order of appearance)

Simon Hengel <simon.hengel@wiktory.org>

Sakari Jokinen <sakariij@gmail.com>

Something went wrong with that request. Please try again.