On 18 November 2011 16:09, Johan Tibell <johan.tib...@gmail.com> wrote:
> Hi all,
> I spent some time today documenting a library and the experience left me
> wanting a better markup language. In particular, Haddock lacks:
>  * markup for bold text: bold text works better than italics for emphasis on
> computer monitors.

Even for the italics offered by /.../ would ideally be replaced, as
too often people (including myself) forget to escape paths or when
listing alternatives (e.g. foo/bar), leading to borked documentation.

>  * hyperlinks with anchor texts: having the actual URL rendered inline with
> text hurts readability.
> Could Haddock markup be extended to also include some Markdown features? The
> new features could be hidden behind a flag so old documentation doesn't get
> unwanted markup (e.g. if it uses *...* to not mean bold).

Wasn't there talk at one stage of integrating pandoc into haddock?

-- 
Ivan Lazar Miljenovic
ivan.miljeno...@gmail.com
IvanMiljenovic.wordpress.com

_______________________________________________
Haskell-Cafe mailing list
Haskell-Cafe@haskell.org
http://www.haskell.org/mailman/listinfo/haskell-cafe

Reply via email to