it seems that symbols like \ and ' are gone form the generated documentation
Isaac Dupree
ml at isaac.cedarswampstudios.org
Thu Dec 9 21:10:36 CET 2010
On 12/09/10 13:36, David Waern wrote:
> 2010/12/9 Mitar<mmitar at gmail.com>:
>> Hi!
>>
>> On Thu, Dec 9, 2010 at 3:03 PM, Sebastian Fischer<fischer at nii.ac.jp> wrote:
>>> Maybe this is also necessary inside code blocks in documentation
>>> comments.
>>
>> There are two types of code blocks. Those with @ where you have to
>> escape and those with> where you do not have to escape. So changing
>> to> in this documentation case would solve the problem, probably.
>
> Ah, yes that is indeed correct, and also described in the manual. @
> ... @ is markup for monospaced text where you can still use normal
> Hadock markup to get e.g. hyperlinked identifiers and whatnot.
>
> That's why `catch` gets wrapped in a<code> tag --<code> is how me
> markup identifiers.
We could warn for `...` being <code> markup. The Haddock-user can use
one or both ' quote marks instead. This mistake is made in Haddock
documentation all over the place, because `...` has a common meaning in
Haskell of infix, and the resulting documentation looks only moderately
wrong.
-Isaac
More information about the Libraries
mailing list