Difference between revisions of "DocTest"
Jump to navigation
Jump to search
SimonHengel (talk | contribs) |
SimonHengel (talk | contribs) m |
||
| (21 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | The content of this page has moved to: https://github.com/sol/doctest-haskell#readme |
||
| − | ==What is DocTest== |
||
| − | 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]. |
||
| − | |||
| − | ==Usage== |
||
| − | Bellow is a small Haskell module with DocTest examples: |
||
| − | |||
| − | <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> |
||
| − | |||
| − | DocTest checks if the implementation of <hask>fib</hask> |
||
| − | satisfies the given examples: |
||
| − | |||
| − | <pre> |
||
| − | $ doctest Fib.hs |
||
| − | </pre> |
||
| − | |||
| − | |||
| − | Lines starting with <hask>-- ></hask> denote ''expressions''. |
||
| − | All comment lines following an expression denote the |
||
| − | ''result'' of that expression, where result is defined by what a |
||
| − | REPL prints to standard output 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/ |
||
Revision as of 15:16, 23 June 2012
The content of this page has moved to: https://github.com/sol/doctest-haskell#readme