Package description parser interprets curly braces in the description field

[bos]

(Imported from Trac #784, reported by guest on 2010-12-29)

If you have a description like this:

description: Here is some C code:
             .
             > for(i = 0; i < 100; i++){
             >   printf("%d\n",i);
             > }
             .

Cabal will strip out the brackets. You can use @..@ syntax with { and } except that then the whitespace is off in your code block and you have to escape any symbols that haddock knows. Putting a blackslash () in front the braces does not help.

The above example works fine in plain haddock leading me the conclusion that cabal is eating the braces.

[manzyuk]

Braces play a special role in .cabal files as they delimit sections and branches of conditionals. They are stripped by the parser as soon as the boundaries of sections / branches have been figured out. One could augment the tokenizer so that the lines beginning with '>' are left intact. I tried that and this fixes the above example.

Is it a good / right way to fix this issue? Am I overlooking anything?

This change doesn't fix stripping of the curly braces in code blocks delimited by @...@, which haddock seems to handle fine. I suppose this could also be fixed by changing the tokenizer.

[23Skidoo]

@manzyuk

One could augment the tokenizer so that the lines beginning with '>' are left intact. I tried that and this fixes the above example.
Is it a good / right way to fix this issue? Am I overlooking anything?

Please submit a pull request, and we'll take a look at it.