[Haddock] Haddock markup support for properties

David Waern david.waern at gmail.com
Fri Apr 27 09:55:27 BST 2012

Hi Simon,

2012/4/27 Simon Hengel <sol at typeful.net>:
> (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 think a prompt (...>) looks better when there's code to the right. I
suppose if we add JavaDoc-like attributes later we could make an
attribute for properties. So I'd go with the former for now.


More information about the Haddock mailing list