haskell / haddock

Haskell Documentation Tool

Home Page:www.haskell.org/haddock/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bold syntax doesn't render correctly when text flows over one lines.

malteneuss opened this issue · comments

Bold long text that spans over one line isn't rendered as bold, at least with block comments:

{- | 
__This 
doesn't work__
-}

However, it works when the text stays on one line:

{- | 
__This works__
-}

Tested with Haddock version 2.24.2 within Stack version 2.7.3 x86_64 hpack-0.34.4 on NixOS 21.11, GHC version 8.10.7.

This appears to be expected behavior. See the relevant test for the parser. This has also been Haddock's behavior since bold support was added in ef9aa98.

How about adding a hint to the docs? I could add a PR in the next days.

That would be fantastic