From 122fe6edaeae55e77d606e6d57aa1904bbfb55c4 Mon Sep 17 00:00:00 2001 From: Simon Hengel Date: Sun, 2 Nov 2014 12:19:38 +0800 Subject: 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. --- doc/haddock.xml | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) (limited to 'doc/haddock.xml') 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! -- | 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@. To produce output something like this: @@ -2061,13 +2061,8 @@ This belongs to the list above! Each paragraph should be preceded by the - “definition term” 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 [ character, then - it is assumed to be a definition paragraph, and the next - ] character found will close the definition - term. Other markup operators may be used freely within the + “definition term” enclosed in square brackets and followed by a colon. + Other markup operators may be used freely within the definition term. You can escape ] with a backslash as usual. Same rules about nesting and no newline separation as for bulleted and numbered lists apply. -- cgit v1.2.3