[haddock @ 2005-02-23 15:57:12 by simonmar]

Fix documentation regarding the module attributes.

1 files changed, 8 insertions, 0 deletions

diff --git a/doc/haddock.xml b/doc/haddock.xml
index b4464720..f9dbb1ff 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -1183,11 +1183,19 @@ import B
 
 <programlisting>
 -- #hide, prune, ignore-exports
+
 -- |Module description
 module A where
 ...
 </programlisting>
 
+      <para>The options and module description can be in either order, but
+	remember to separate them using a blank line if you are using the
+	<literal>--</literal> style comments.  Without the blank line in the
+	example above, the module description would be assumed to be part of
+	the options, and Haddock would complain about unrecognised
+	options.</para>
+
       <para>The following attributes are currently understood by
       Haddock:</para>