Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Two parse errors? #291

Closed
ghc-mirror opened this issue May 8, 2014 · 1 comment
Closed

Two parse errors? #291

ghc-mirror opened this issue May 8, 2014 · 1 comment

Comments

@ghc-mirror
Copy link

Original reporter: y30099923@

The $block parsing seems to be a bit wonky. Or maybe I'm just doing this wrong. There are two parse errors in this example:

  1. The italics markup simply doesn't work in $locations.

  2. the $foldable block isn't generated.

@ghc-mirror ghc-mirror self-assigned this May 8, 2014
@ghc-mirror
Copy link
Author

Original reporter: fuuzetsu@

See, #126 for 1), wontfix

For 2), you're asking Haddock to insert $foldables but only define $foldable (you have an extra ‘s’). Further, you (apparently) can't ask for empty sections. That is,

-- * foo
-- $stuff
-- ** bar
-- $stuff2

is not going to cut it. You actually need something between $stuff and ** bar. Perhaps this is a (documentation) bug on its own but not the reported one. Actually export something between the sections

-- * foo
-- $stuff
someFunction
-- ** bar
-- $stuff2

I'll have to look into why it doesn't do what one would take a guess at but I think it's intentional.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant