Skip to content
Snippets Groups Projects
Unverified Commit c2dc73cf authored by malteneuss's avatar malteneuss Committed by GitHub
Browse files

Add hint about inline link issue (#1444)

parent 0000202c
No related branches found
No related tags found
5 merge requests!38Make --no-tmp-comp-dir the default,!37Adapt to latest xhtml version, various optimizations,!31Support HsToken in DataDecl and ClassDecl,!12Drop orphan instance when defined upstream.,!10Haddock interfaces produced from `.hi` files
......@@ -1121,6 +1121,17 @@ followed by the URL enclosed in regular parentheses, for example: ::
The link text is used as a description for the URL if the output
format supports it.
Hint: There's a `known issue <https://github.com/haskell/haddock/issues/774>`_
that any inline link at the beginning of a line within a multi-line comment
isn't rendered correctly: ::
{-| Some multi-line comment that has a
[link](https://example.com) and a
[reference link]: https://example.com
-}
Adding a space or a word in front of such a link can be used as a workaround.
Images
~~~~~~
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment