Personal tools

Haddock/Development ideas

From HaskellWiki

< Haddock(Difference between revisions)
Jump to: navigation, search
(create page with a number of possible haddock features)
(doctest does the QC stuff)
(16 intermediate revisions by 11 users not shown)

Latest revision as of 19:11, 14 March 2014

Most of these ideas are very old, but some may still be relevant.

  • It would be good to have a recursive flag that would operate on all the .hs and .lhs files under a single directory.
  • There should be an annotation to include a function's entire definition in the documentation. This would be useful for functions like
    where the definition is the clearest possible documentation.
  • There should be an option to include a simplified implementation of a function that is equivalent to the one in the code. For instance, instead of showing a complex implementation of List.length that makes use of stream fusion we could show a simple one based on foldl'.
  • Optionally show qualifications of identifiers, that is print
    rather than
    rather than just
    . The option for haddock could be --qualification QUAL
    • none (default) strip off qualification (just
    • orig show the identifiers as they are written in the module (e.g.
    • full show all identifiers with full qualification (