Blame test/haddock-reader.haddock

Packit Service d2f85f
This file tests the Pandoc reader for Haddock.
Packit Service d2f85f
We've borrowed examples from Haddock's documentation: <http://www.haskell.org/haddock/doc/html/ch03s08.html>.
Packit Service d2f85f
Packit Service d2f85f
The following characters have special meanings in Haddock, \/, \', \`, \", \@, \<, so they must be escaped.
Packit Service d2f85f
Packit Service d2f85f
\* This is a paragraph, not a list item.
Packit Service d2f85f
\> This sentence is not code.
Packit Service d2f85f
\>\>\> This is not an example.
Packit Service d2f85f
Packit Service d2f85f
The references λ, λ and λ all represent the lower-case letter lambda.
Packit Service d2f85f
Packit Service d2f85f
This is a code block:
Packit Service d2f85f
Packit Service d2f85f
> map :: (a -> b) -> [a] -> [b]
Packit Service d2f85f
> map _ []     = []
Packit Service d2f85f
> map f (x:xs) = f x : map f xs
Packit Service d2f85f
Packit Service d2f85f
This is another code block:
Packit Service d2f85f
Packit Service d2f85f
@
Packit Service d2f85f
f x = x + x.
Packit Service d2f85f
The \@...\@ code block /interprets markup normally/.
Packit Service d2f85f
"Module.Foo"
Packit Service d2f85f
\"Hello World\"
Packit Service d2f85f
@
Packit Service d2f85f
Packit Service d2f85f
Haddock supports REPL examples:
Packit Service d2f85f
Packit Service d2f85f
>>> fib 10
Packit Service d2f85f
55
Packit Service d2f85f
>>> putStrLn "foo\nbar"
Packit Service d2f85f
foo
Packit Service d2f85f
bar
Packit Service d2f85f
Packit Service d2f85f
That was /really cool/!
Packit Service d2f85f
I had no idea @fib 10 = 55@.
Packit Service d2f85f
Packit Service d2f85f
This module defines the type 'T'.
Packit Service d2f85f
The identifier 'M.T' is not in scope
Packit Service d2f85f
I don't have to escape my apostrophes; great, isn't it?
Packit Service d2f85f
This is a reference to the "Foo" module.
Packit Service d2f85f
Packit Service d2f85f
This is a bulleted list:
Packit Service d2f85f
Packit Service d2f85f
  * first item
Packit Service d2f85f
Packit Service d2f85f
  * second item
Packit Service d2f85f
Packit Service d2f85f
This is an enumerated list:
Packit Service d2f85f
Packit Service d2f85f
  (1) first item
Packit Service d2f85f
Packit Service d2f85f
  2. second item
Packit Service d2f85f
Packit Service d2f85f
This is a definition list:
Packit Service d2f85f
Packit Service d2f85f
  [@foo@] The description of @foo@.
Packit Service d2f85f
Packit Service d2f85f
  [@bar@] The description of @bar@.
Packit Service d2f85f
Packit Service d2f85f
Here is a link: <http://haskell.org>
Packit Service d2f85f
Packit Service d2f85f
<http://haskell.org Haskell> is a fun language!
Packit Service d2f85f
Packit Service d2f85f
<http://example.com Click Here!>