[Haskell-cafe] Haddock question

2010-07-21 Thread S. Doaitse Swierstra
I am trying to document my parser library. In order to do so I should like to include some example output in my haddock documentation. I fail to see however how to get a block of output into the haddock part. E.g. -- | We can now run the parser @`pa`@ on input \a\, which succeeds: -- @

[Haskell-cafe] Haddock question

2010-07-21 Thread S. Doaitse Swierstra
I am trying to document my parser library. In order to do so I should like to include some example output in my haddock documentation. I fail to see however how to get a block of output into the haddock part. E.g. -- | We can now run the parser @`pa`@ on input \a\, which succeeds: -- @

Re: [Haskell-cafe] Haddock question

2010-07-21 Thread Daniel Fischer
On Wednesday 21 July 2010 16:09:37, S. Doaitse Swierstra wrote: I am trying to document my parser library. In order to do so I should like to include some example output in my haddock documentation. I fail to see however how to get a block of output into the haddock part. E.g. -- | We can

Re: [Haskell-cafe] Haddock question

2010-07-21 Thread S. Doaitse Swierstra
Unfortunately I get for input: -- | We can now run the parser @`pa`@ on input \a\, which succeeds: -- @ -- Result: \a\ -- Second line -- @ the output We can now run the parser pa on input a, which succeeds: Result: a Second line Doaitse On 21 jul 2010, at 16:17, Daniel Fischer

Re: [Haskell-cafe] Haddock question

2010-07-21 Thread Daniel Fischer
On Wednesday 21 July 2010 16:23:48, S. Doaitse Swierstra wrote: Unfortunately I get for input: -- | We can now run the parser @`pa`@ on input \a\, which succeeds: -- @ -- Result: \a\ -- Second line -- @ the output You need to separate the @'d paragraph from the rest of the comment by

Re: [Haskell-cafe] Haddock question

2010-07-21 Thread Ivan Lazar Miljenovic
S. Doaitse Swierstra doai...@cs.uu.nl writes: Unfortunately I get for input: -- | We can now run the parser @`pa`@ on input \a\, which succeeds: -- @ -- Result: \a\ -- Second line -- @ the output We can now run the parser pa on input a, which succeeds: Result: a Second line

[Haskell-cafe] Haddock question: hiding internal instances

2010-01-15 Thread Niklas Broberg
Hi all, The question I have is this: How can I get Haddock to omit listing instances of package-internal data types for exported classes? Here's an example of what I mean: http://hackage.haskell.org/packages/archive/haskell-src-exts/1.6.0/doc/html/Language-Haskell-Exts-Pretty.html#t%3APretty

Re: [Haskell-cafe] Haddock question: hiding internal instances

2010-01-15 Thread David Waern
2010/1/15 Niklas Broberg niklas.brob...@gmail.com: Hi all, The question I have is this: How can I get Haddock to omit listing instances of package-internal data types for exported classes? You currently can't, unfortunately. See: http://trac.haskell.org/haddock/ticket/37 David

Re: [Haskell-cafe] Haddock question: hiding internal instances

2010-01-15 Thread Ross Paterson
On Fri, Jan 15, 2010 at 09:16:03PM +0100, Niklas Broberg wrote: The question I have is this: How can I get Haddock to omit listing instances of package-internal data types for exported classes? It's a known limitation: http://trac.haskell.org/haddock/ticket/37

Re: [Haskell-cafe] Haddock question: hiding internal instances

2010-01-15 Thread Niklas Broberg
The question I have is this: How can I get Haddock to omit listing instances of package-internal data types for exported classes? You currently can't, unfortunately. See:  http://trac.haskell.org/haddock/ticket/37 Roger that, cc added. Cheers, /Niklas

[Haskell-cafe] haddock question

2008-11-27 Thread allan
Dear all I'm trying to locally build the documentation for the haskell-src-exts package and running into a bit of bother. If I run: cabal haddock I get the error: haddock: parse error in doc string so: cabal haddock -v Doesn't really provide any extra information, it gives me the exact haddock

Re: [Haskell-cafe] haddock question [solved]

2008-11-27 Thread allan
Ross Paterson wrote: On Thu, Nov 27, 2008 at 11:52:04AM +, allan wrote: I'm trying to locally build the documentation for the haskell-src-exts package and running into a bit of bother. If I run: cabal haddock I get the error: haddock: parse error in doc string The problem is that

Re: [Haskell-cafe] haddock question

2008-11-27 Thread Ross Paterson
On Thu, Nov 27, 2008 at 11:52:04AM +, allan wrote: I'm trying to locally build the documentation for the haskell-src-exts package and running into a bit of bother. If I run: cabal haddock I get the error: haddock: parse error in doc string The problem is that several of the modules (not

[Haskell-cafe] Haddock question

2006-11-25 Thread Luis Cabellos
Hello, I follow the How to Write a Haskell program from http://www.haskell.org/haskellwiki/How_to_write_a_Haskell_program, but I have a problem with Haddock. I use Windows XP, I when I install GHC + Haddock I have this warning output C:\code\haskell\test runhaskell Setup.hs haddock

Re: [Haskell-cafe] Haddock question

2006-11-25 Thread Donald Bruce Stewart
zhen.sydow: Hello, I follow the How to Write a Haskell program from http://www.haskell.org/haskellwiki/How_to_write_a_Haskell_program, but I have a problem with Haddock. I use Windows XP, I when I install GHC + Haddock I have this warning output C:\code\haskell\test runhaskell Setup.hs