[Haddock] [haddock] #140: Support for doctest style usage blocks

haddock haddock at projects.haskell.org
Thu Aug 12 07:13:28 EDT 2010


#140: Support for doctest style usage blocks
------------------------+---------------------------------------------------
Reporter:  ezyang       |        Owner:       
    Type:  enhancement  |       Status:  new  
Priority:  major        |    Milestone:  2.8.0
 Version:  2.6.0        |   Resolution:       
Keywords:               |  
------------------------+---------------------------------------------------
Changes (by waern):

  * milestone:  2.7.0 => 2.8.0

Comment:

 Good news:

 Simon Hegel is working on this and has added markup for examples, looking
 like this:

 {{{
 -- | Documentation for 'f'
 --
 -- ghci> f 3
 -- 15
 --
 f :: Int -> Int
 f x = x * 5
 }}}
 He's got a DocTest program that is the Haskell-equivalent of python's
 doctest.

 We're currently working on extending the Haddock API so that DocTest can
 get what it wants from the .haddock files.

-- 
Ticket URL: <http://trac.haskell.org/haddock/ticket/140#comment:1>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool


More information about the Haddock mailing list