From c369e055597eadcd5b68f966afcc2453f5174a4c Mon Sep 17 00:00:00 2001 From: David Waern Date: Wed, 1 Sep 2010 11:19:21 +0000 Subject: Replace ghci> with >>> in example syntax --- doc/haddock.xml | 10 +++++----- src/Haddock/Backends/Xhtml/DocMarkup.hs | 2 +- src/Haddock/Lex.x | 6 +++--- src/Haddock/Types.hs | 2 +- tests/golden-tests/tests/Examples.hs | 14 +++++++------- tests/golden-tests/tests/Examples.html.ref | 14 +++++++------- 6 files changed, 24 insertions(+), 24 deletions(-) diff --git a/doc/haddock.xml b/doc/haddock.xml index 58047598..39c4f9d2 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -1508,9 +1508,9 @@ module A where *, -. These characters can also be escaped using \. - Furthermore, the character sequence ghci> + Furthermore, the character sequence >>> has a special meaning at the beginning of a line. To - escape it, just prefix the > character with a + escape it, just prefix the characters in the sequence with a backslash. @@ -1568,16 +1568,16 @@ module A where Haddock has markup support for examples of interaction with a read-eval-print loop (REPL). An example is introduced with - ghci> followed by an expression followed + >>> followed by an expression followed by zero or more result lines: -- | Two examples are given bellow: -- --- ghci> fib 10 +-- >>> fib 10 -- 55 -- --- ghci> putStrLn "foo\nbar" +-- >>> putStrLn "foo\nbar" -- foo -- bar diff --git a/src/Haddock/Backends/Xhtml/DocMarkup.hs b/src/Haddock/Backends/Xhtml/DocMarkup.hs index b1260a9c..be9ae876 100644 --- a/src/Haddock/Backends/Xhtml/DocMarkup.hs +++ b/src/Haddock/Backends/Xhtml/DocMarkup.hs @@ -69,7 +69,7 @@ parHtmlMarkup ppId isTyCon = Markup { exampleToHtml (Example expression result) = htmlExample where htmlExample = htmlPrompt +++ htmlExpression +++ (toHtml $ unlines result) - htmlPrompt = (thecode . toHtml $ "ghci> ") ! [theclass "prompt"] + htmlPrompt = (thecode . toHtml $ ">>> ") ! [theclass "prompt"] htmlExpression = (strong . thecode . toHtml $ expression ++ "\n") ! [theclass "userinput"] diff --git a/src/Haddock/Lex.x b/src/Haddock/Lex.x index fc3b3d51..4f877fc9 100644 --- a/src/Haddock/Lex.x +++ b/src/Haddock/Lex.x @@ -48,7 +48,7 @@ $ident = [$alphanum \'\_\.\!\#\$\%\&\*\+\/\<\=\>\?\@\\\\\^\|\-\~\:] <0,para> { $ws* \n ; $ws* \> { begin birdtrack } - $ws* ghci \> { strtoken TokExamplePrompt `andBegin` exampleexpr } + $ws* \>\>\> { strtoken TokExamplePrompt `andBegin` exampleexpr } $ws* [\*\-] { token TokBullet `andBegin` string } $ws* \[ { token TokDefStart `andBegin` def } $ws* \( $digit+ \) { token TokNumber `andBegin` string } @@ -59,7 +59,7 @@ $ident = [$alphanum \'\_\.\!\#\$\%\&\*\+\/\<\=\>\?\@\\\\\^\|\-\~\:] -- beginning of a line { $ws* \> { begin birdtrack } - $ws* ghci \> { strtoken TokExamplePrompt `andBegin` exampleexpr } + $ws* \>\>\> { strtoken TokExamplePrompt `andBegin` exampleexpr } $ws* \n { token TokPara `andBegin` para } -- Here, we really want to be able to say -- $ws* (\n | ) { token TokPara `andBegin` para} @@ -74,7 +74,7 @@ $ident = [$alphanum \'\_\.\!\#\$\%\&\*\+\/\<\=\>\?\@\\\\\^\|\-\~\:] { $ws* \n { token TokPara `andBegin` para } - $ws* ghci \> { strtoken TokExamplePrompt `andBegin` exampleexpr } + $ws* \>\>\> { strtoken TokExamplePrompt `andBegin` exampleexpr } () { begin exampleresult } } diff --git a/src/Haddock/Types.hs b/src/Haddock/Types.hs index 3ec37469..33892e49 100644 --- a/src/Haddock/Types.hs +++ b/src/Haddock/Types.hs @@ -296,7 +296,7 @@ data Example = Example exampleToString :: Example -> String exampleToString (Example expression result) = - "ghci> " ++ expression ++ "\n" ++ unlines result + ">>> " ++ expression ++ "\n" ++ unlines result data DocMarkup id a = Markup { diff --git a/tests/golden-tests/tests/Examples.hs b/tests/golden-tests/tests/Examples.hs index ed22b614..7b703428 100644 --- a/tests/golden-tests/tests/Examples.hs +++ b/tests/golden-tests/tests/Examples.hs @@ -4,28 +4,28 @@ module Examples where -- -- Examples: -- --- ghci> fib 5 +-- >>> fib 5 -- 5 --- ghci> fib 10 +-- >>> fib 10 -- 55 -- --- ghci> fib 10 +-- >>> fib 10 -- 55 -- -- One more Example: -- --- ghci> fib 5 +-- >>> fib 5 -- 5 -- -- One more Example: -- --- ghci> fib 5 +-- >>> fib 5 -- 5 -- -- Example with an import: -- --- ghci> import Data.Char --- ghci> isSpace 'a' +-- >>> import Data.Char +-- >>> isSpace 'a' -- False -- fib :: Integer -> Integer diff --git a/tests/golden-tests/tests/Examples.html.ref b/tests/golden-tests/tests/Examples.html.ref index 9139ac80..3bf475ab 100644 --- a/tests/golden-tests/tests/Examples.html.ref +++ b/tests/golden-tests/tests/Examples.html.ref @@ -3,20 +3,20 @@ window.onload = function () {pageLoad();setSynopsis("mini_Examples.html");}; //]]>

Examples

Synopsis

Documentation

fib :: Integer -> Integer

Fibonacci number of given Integer.

Examples: -

ghci> fib 5
+
>>> fib 5
 5
-ghci> fib 10
+>>> fib 10
 55
-
ghci> fib 10
+
>>> fib 10
 55
 
One more Example:
-
ghci> fib 5
+
>>> fib 5
 5
 
One more Example:
-
ghci> fib 5
+
>>> fib 5
 5
 
Example with an import:
-
ghci> import Data.Char
-ghci> isSpace 'a'
+
>>> import Data.Char
+>>> isSpace 'a'
 False
\ No newline at end of file -- cgit v1.2.3