[Haddock] Haddock markup support for properties

Simon Marlow marlowsd at gmail.com
Fri Apr 27 09:54:44 BST 2012

On 27/04/2012 07:11, Simon Hengel wrote:
> (CCing the Haddock mailing list, Kazu Yamamoto and Simon Marlow)
> Hi David,
> Kazu Yamamoto is adding support for QuickCheck properties to doctest.
> So we need to decide on concrete syntax for properties in Haddock
> comments.  Previously we designated `prop>' for that[1].  Do you still
> think this is a good choice?
> Here is an example from [2].
>      prop>  isSearchPathSeparator a == (a == searchPathSeparator)
> I'm asking because we recently discussed whether we need something akin
> to JavaDoc's @, e.g. %.  If we would intend to introduce something like
> that, then using %prop for properties may be an option.
>      %prop isSearchPathSeparator a == (a == searchPathSeparator)

I don't have a strong opinion on the syntax.  Either is fine by me.


More information about the Haddock mailing list