# DocTest

### From HaskellWiki

(Difference between revisions)

SimonHengel (Talk | contribs) m (fixed typo) |
SimonHengel (Talk | contribs) m |
||

(19 intermediate revisions by one user not shown) | |||

Line 1: | Line 1: | ||

− | ==What is DocTest== |
+ | The content of this page has moved to: https://github.com/sol/doctest-haskell#readme |

− | DocTest is a small program, that checks examples in |
||

− | Haskell comments. It is modeled after |
||

− | [http://docs.python.org/library/doctest.html doctest for Python]. |
||

− | |||

− | ==Tutorial== |
||

− | 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. |
||

− | |||

− | <haskell> |
||

− | module Fib where |
||

− | |||

− | -- Examples: |
||

− | -- |
||

− | -- > fib 10 |
||

− | -- 55 |
||

− | |||

− | -- > fib 5 |
||

− | -- 5 |
||

− | |||

− | fib 0 = 0 |
||

− | fib 1 = 1 |
||

− | fib n = fib (n - 1) + fib (n - 2) |
||

− | </haskell> |
||

− | |||

− | With DocTest you may checks if the implementation satisfies the given examples, by typing (on your Unix shell): |
||

− | |||

− | <pre> |
||

− | $ doctest Fib.hs |
||

− | </pre> |
||

− | |||

− | |||

− | Lines starting with <hask>-- ></hask> denote ''expressions''. |
||

− | All comment lines following an expression denote the |
||

− | ''result'' of that expression. Result is defined by what an [http://en.wikipedia.org/wiki/Read-eval-print_loop REPL] |
||

− | (e.g. ghci) prints to <hask>stdout</hask> and <hask>stderror</hask> when |
||

− | evaluating that expression. |
||

− | |||

− | ==DocTest on Hackage== |
||

− | http://hackage.haskell.org/cgi-bin/hackage-scripts/package/DocTest |
||

− | |||

− | ==Branches== |
||

− | http://code.haskell.org/~sih/code/DocTest.git/ |

## Latest revision as of 15:16, 23 June 2012

The content of this page has moved to: https://github.com/sol/doctest-haskell#readme