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

Some parts of the doc info (on hover) are incorrectly wrapped inside code tags #991

Closed
moodmosaic opened this issue Jan 23, 2020 · 3 comments · Fixed by haskell/ghcide#344

Comments

@moodmosaic
Copy link
Contributor

The overall feature looks neat, but some parts of the :doc are incorrectly wrapped in <code></code>

image

As @serras points out, the origin of this may be at the transform of Haddock into Markdown.


Should this be reported in https://github.com/haskell/haddock instead, please let me know.

@serras
Copy link
Contributor

serras commented Jan 23, 2020

This seems to be caused by the fact that the docs for unsafePerformIO read as follows:

  * Use @{\-\# NOINLINE foo \#-\}@ as a pragma on any function @foo@
        that calls 'unsafePerformIO'.  If the call is inlined,
        the I\/O may be performed more than once.

Unfortunately, having so many spaces before a line is parsed by Markdown as being a code block, hence the problem.

@moodmosaic
Copy link
Contributor Author

Oh, I guess we can send them a pull request 😉 Thank you for looking into it 💯

@serras
Copy link
Contributor

serras commented Jan 24, 2020

I really think this is on our side, since the comment in unsafePerformIO is valid Haddock. I've put up a fix in haskell/ghcide#344, which seems to render those docs correctly and not break anything else.

@moodmosaic moodmosaic reopened this Jan 24, 2020
@pepeiborra pepeiborra transferred this issue from haskell/ghcide Jan 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants