| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Test.DocTest.Internal.Run
Synopsis
- doctest :: [String] -> IO ()
- doctestWithRepl :: (String, [String]) -> [String] -> IO ()
- data Config = Config {}
- defaultConfig :: Config
- doctestWith :: Config -> IO ()
- type Result = Summary
- data Summary = Summary {}
- isSuccess :: Result -> Bool
- evaluateResult :: Result -> IO ()
- doctestWithResult :: Config -> IO Result
- runDocTests :: Config -> [Module [Located DocTest]] -> IO Result
Documentation
doctest :: [String] -> IO () Source #
Run doctest with given list of arguments.
Example:
>>>doctest ["-iexample/src", "example/src/Example.hs"]... Examples: 2 Tried: 2 Errors: 0 Failures: 0
This can be used to create a Cabal test suite that runs doctest for your project.
If a directory is given, it is traversed to find all .hs and .lhs files inside of it, ignoring hidden entries.
Constructors
| Config | |
doctestWith :: Config -> IO () Source #
Summary of a test run.
evaluateResult :: Result -> IO () Source #