aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon Hengel <sol@typeful.net>2014-11-02 12:19:38 +0800
committerSimon Hengel <sol@typeful.net>2014-11-03 09:34:20 +0800
commit122fe6edaeae55e77d606e6d57aa1904bbfb55c4 (patch)
tree58fa9ffca7e586963efece9f9046edb2890d44a2 /doc
parentaf85d14f001cf4c2976ee659ec04101d6b054a4d (diff)
Allow an optional colon after the closing bracket of definition lists
This is to disambiguate them from markdown links and will be require with a future release.
Diffstat (limited to 'doc')
-rw-r--r--doc/haddock.xml13
1 files changed, 4 insertions, 9 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml
index ee77ede9..618e19f2 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -2038,9 +2038,9 @@ This belongs to the list above!
<programlisting>
-- | This is a definition list:
--
--- [@foo@] The description of @foo@.
+-- [@foo@]: The description of @foo@.
--
--- [@bar@] The description of @bar@.
+-- [@bar@]: The description of @bar@.
</programlisting>
<para>To produce output something like this:</para>
@@ -2061,13 +2061,8 @@ This belongs to the list above!
</variablelist>
<para>Each paragraph should be preceded by the
- &ldquo;definition term&rdquo; enclosed in square brackets.
- The square bracket characters have no special meaning outside
- the beginning of a definition paragraph. That is, if a
- paragraph begins with a <literal>[</literal> character, then
- it is assumed to be a definition paragraph, and the next
- <literal>]</literal> character found will close the definition
- term. Other markup operators may be used freely within the
+ &ldquo;definition term&rdquo; enclosed in square brackets and followed by a colon.
+ Other markup operators may be used freely within the
definition term. You can escape <literal>]</literal> with a backslash as usual.</para>
<para>Same rules about nesting and no newline separation as for bulleted and numbered lists apply.