diff options
| -rw-r--r-- | doc/haddock.xml | 38 |
1 files changed, 32 insertions, 6 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml index 680f7980..b779f835 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -1409,12 +1409,15 @@ module A where one of these special characters, precede it with a backslash (<literal>\</literal>).</para> - <para>Additionally, the character <literal>></literal> has - a special meaning at the beginning of a line, and the - following characters have special meanings at the beginning of - a paragraph: - <literal>*</literal>, <literal>-</literal>. These characters - can also be escaped using <literal>\</literal>.</para> + <para>Additionally, the character <literal>></literal> and + the character sequence <literal>ghci></literal> have special + meanings at the beginning of a line. The following characters + have special meanings at the beginning of a paragraph: + <literal>*</literal>, <literal>-</literal>. The single + characters can also be escaped using <literal>\</literal>. To + get a literal <literal>ghci></literal> at the beginning of a + line, prefix the <literal>></literal> with a + backslash.</para> </section> <section> @@ -1466,6 +1469,29 @@ module A where </section> <section> + <title>Interactive Examples</title> + + <para> Haddock has markup support for interactive examples, that + illustrate the use of source constructs in a + <emphasis>read-eval-print loop (REPL)</emphasis>. An + interactive example is introduced with + <literal>ghci></literal> followed by an expression followed + by zero or more result lines:</para> + +<programlisting> +-- | Two examples are given bellow: +-- +-- ghci> fib 10 +-- 55 +-- +-- ghci> putStrLn "foo\nbar" +-- foo +-- bar +</programlisting> + </section> + + + <section> <title>Hyperlinked Identifiers</title> <para>Referring to a Haskell identifier, whether it be a type, |