-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Test interactive Haskell examples
--   
--   The doctest program checks examples in source code comments. It is
--   modeled after doctest for Python
--   (<a>https://docs.python.org/3/library/doctest.html</a>).
--   
--   Documentation is at <a>https://github.com/sol/doctest#readme</a>.
@package doctest
@version 0.18

module Test.DocTest

-- | Run doctest with given list of arguments.
--   
--   Example:
--   
--   <pre>
--   &gt;&gt;&gt; doctest ["-iexample/src", "example/src/Example.hs"]
--   Examples: 2  Tried: 2  Errors: 0  Failures: 0
--   </pre>
--   
--   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.
doctest :: [String] -> IO ()