Parse pragmas in @@ blocks

[Lysxia]

The following comment

-- @
-- {-# LANGUAGE DeriveGeneric #-}
-- @

Gets interpreted as containing an anchor # LANGUAGE DeriveGeneric #, {-<a id=" LANGUAGE DeriveGeneric "></a>-}, so people will just see this in the rendered doc:

{--}

The current workaround is to escape the #:

-- @
-- {-\# LANGUAGE DeriveGeneric \#-}
-- @

The problem is that it is very easy to miss.

It would be nice to detect this situation automatically and not parse these as anchors, so we wouldn't have to escape them. Some possible criteria:

• Don't recognize anchors #...# containing/starting with/ending with spaces
• Don't recognize anchors #...# surrounded by {-, -}
• Don't recognize anchors in the middle of code blocks

[harpocrates]

Are HTML anchors even technically allowed to have space in them? If not, I think the first criteria is one we should definitely add!

[Lysxia]

Ah you're right! That makes it easy!

id's value must not contain whitespace

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id

[harpocrates]

If you have time for a PR, it should be pretty straightforward:

haddock/haddock-library/src/Documentation/Haddock/Parser.hs

Line 230 in 5dc3866

disallowNewline ("#" *> takeWhile1_ (/= '#') <* "#")

Then maybe a comment here about how the anchor name should be whitespace-free:

haddock/haddock-library/src/Documentation/Haddock/Types.hs

Lines 128 to 129 in 5dc3866

	| DocAName String
	-- ^ A (HTML) anchor.

And finally a simple unit test in Documentation.Haddock.ParserSpec.

[Lysxia]

Thanks! I'll work on it.