Difference between revisions of "Haddock/Development ideas"
< Haddock
Jump to navigation
Jump to search
Benmachine (talk | contribs) (Removing ideas that are now implemented or irrelevant.) |
(Remove implemented idea) |
||
| Line 2: | Line 2: | ||
* It would be good to have a recursive flag that would operate on all the .hs and .lhs files under a single directory. |
* It would be good to have a recursive flag that would operate on all the .hs and .lhs files under a single directory. |
||
| − | * Haddock should emit the documentation about instances. For example, it's important to document that the Data.Map instance of Foldable only folds over the values and not the keys. |
||
* There should be an annotation to include a function's entire definition in the documentation. This would be useful for functions like <hask>(.)</hask> and <hask>mapM</hask> where the definition is the clearest possible documentation, and for QuickCheck properties that specify the behavior of a library. |
* There should be an annotation to include a function's entire definition in the documentation. This would be useful for functions like <hask>(.)</hask> and <hask>mapM</hask> where the definition is the clearest possible documentation, and for QuickCheck properties that specify the behavior of a library. |
||
* 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'. |
* 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'. |
||
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
(.)andmapMwhere the definition is the clearest possible documentation, and for QuickCheck properties that specify the behavior of a library. - 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
Sequence.maprather thanmap,Music.Trather than justT. The option for haddock could be--qualification QUALnone(default) strip off qualification (justmap)origshow the identifiers as they are written in the module (e.g.maporList.map)fullshow all identifiers with full qualification (Data.List.map)