Fragile parsing of anchor references

haskell / haddock

Haskell Documentation Tool

www.haskell.org/haddock/

BSD 2-Clause "Simplified" License

361 stars 241 forks source link

Fragile parsing of anchor references #1284

Open vdukhovni opened 3 years ago

vdukhovni commented 3 years ago

When an anchor reference appears as the first thing on a line it seems to render verbatim, and one needs to be sure to prepend some other word (reflow the text) to avoid this:

bad:
--  ... blah, blah
-- [strict](#strict) blah

good:
-- ... blah,
-- blah [strict](#strict) blah

sjakobi commented 3 years ago

Possible duplicate of https://github.com/haskell/haddock/issues/774.

vdukhovni commented 3 years ago

Agreed, looks to be the same. Is there a fix in the pipeline?

vdukhovni commented 3 years ago

I can close this issue if #774 is not forever dormant...

sjakobi commented 3 years ago

Is there a fix in the pipeline?

I don't think so, unfortunately. Apparently I didn't make a lot of progress when I initially looked into #774, and I'm not planning on returning to that issue any time soon.