aboutsummaryrefslogtreecommitdiff
path: root/doc/haddock.xml
diff options
context:
space:
mode:
authorMateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>2014-10-28 21:57:49 +0000
committerMateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>2014-10-29 03:59:39 +0000
commite2ed3b9d8dfab09f1b1861dbc8e74f08e137ebcc (patch)
tree851c4d06ceb6eff1e0ac31c2c29548cdf830806c /doc/haddock.xml
parent968007937c3e108150a109c12163bbeff978629a (diff)
Experimental support for collapsable headers
Closes #335
Diffstat (limited to 'doc/haddock.xml')
-rw-r--r--doc/haddock.xml23
1 files changed, 21 insertions, 2 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml
index 03970517..662aafd3 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -29,7 +29,7 @@
<holder>Simon Marlow, David Waern</holder>
</copyright>
<abstract>
- <para>This document describes Haddock version 2.15.0, a Haskell
+ <para>This document describes Haddock version 2.15.1, a Haskell
documentation tool.</para>
</abstract>
</bookinfo>
@@ -2143,7 +2143,7 @@ This belongs to the list above!
<programlisting>
-- |
--- = Heading level 1 with some __bold__
+-- = Heading level 1 with some /emphasis/
-- Something underneath the heading.
--
-- == /Subheading/
@@ -2169,6 +2169,25 @@ This belongs to the list above!
-- >>> examples are only allowed at the start of paragraphs
</programlisting>
+ <para>As of 2.15.1, there's experimental (read: subject to
+ change or get removed) support for collapsible headers: simply
+ wrap your existing header title in underscores, as per bold
+ syntax. The collapsible section will stretch until the end of
+ the comment or until a header of equal or smaller number of
+ <literal>=</literal>s.</para>
+
+<programlisting>
+-- |
+-- === __Examples:__
+-- >>> Some very long list of examples
+--
+-- ==== This still falls under the collapse
+-- Some specialised examples
+--
+-- === This is does not go into the collapsable section.
+-- More content.
+</programlisting>
+
</section>
</section>