aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSteve Hart <steve.hart@americandata.consulting>2022-04-12 07:29:46 -0400
committerGitHub <noreply@github.com>2022-04-12 13:29:46 +0200
commite06c1c255377e5245748f4c4003240815deae72f (patch)
treeaf6057647ae082e7b0cba519317a6c8dce013617 /doc
parenta127bb256ec411b2e78edba21299c5dabba3b847 (diff)
Parse Markdown links at beginning of line within a paragraph (#1470)
* Catch Markdown links at beginning of line within paragraph Per Issue #774, Markdown links were being parsed as ordinary text when they occurred at the beginning of a line other than the first line of the paragraph. This occurred because the parser was not interpreting a left square bracket as a special character that could delimit special markup. A space character was considered a special character, so, if a space occurred at the beginning of the new line, then the parser would interpret the space by itself and then continue parsing, thereby catching the Markdown link. '\n' was not treated as a special character, so the parser did not catch a Markdown link that may have followed. Note that this will allow for Markdown links that are not surrounded by spaces. For example, the following text includes a Markdown link that will be parsed: Hello, world[label](url) This is consistent with how the parser handles other types of markup. * Remove obsolete documentation hint Commit 6b9aeafddf20efc65d3725c16e3fc43a20aac343 should eliminate the need for the workaround suggested in the documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/markup.rst11
1 files changed, 0 insertions, 11 deletions
diff --git a/doc/markup.rst b/doc/markup.rst
index abfeb52a..73ec22fd 100644
--- a/doc/markup.rst
+++ b/doc/markup.rst
@@ -1126,17 +1126,6 @@ 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
~~~~~~