Re: [Haskell-cafe] Re: Writing great documentation[MESSAGE NOT SCANNED]

2009-11-14 Thread John O'Donnell
I agree with Duncan's comment: I rather like the idea of using markdown (pandoc) for separate non-reference docs like man pages, tutorials, user guides etc rather than trying to make haddock do everything. In one of my projects (Hydra and Sigma), I use pandoc for the bulk of the documentation

[Haskell-cafe] Re: Writing great documentation

2009-11-13 Thread Gour
On Fri, 13 Nov 2009 22:31:54 + >> "Duncan" == Duncan Coutts wrote: Duncan> I rather like the idea of using markdown (pandoc) for separate Duncan> non-reference docs like man pages, tutorials, user guides etc Duncan> rather than trying to make haddock do everything. I'd agree only with th

Re: [Haskell-cafe] Re: Writing great documentation

2009-11-13 Thread Duncan Coutts
On Fri, 2009-11-13 at 23:20 +0200, Max Rabkin wrote: > On Fri, Nov 13, 2009 at 10:58 PM, Simon Michael wrote: > > A very common problem with online docs is fragmentation. > > Absolutely! Is it possible to include non-haddock documentation in a > cabal package. Is it possible to have it readable o

Re: [Haskell-cafe] Re: Writing great documentation

2009-11-13 Thread Magnus Therning
On 13/11/09 21:20, Max Rabkin wrote: > On Fri, Nov 13, 2009 at 10:58 PM, Simon Michael wrote: >> A very common problem with online docs is fragmentation. > > Absolutely! Is it possible to include non-haddock documentation in a > cabal package. Is it possible to have it readable on Hackage? I thin

Re: [Haskell-cafe] Re: Writing great documentation

2009-11-13 Thread Max Rabkin
On Fri, Nov 13, 2009 at 10:58 PM, Simon Michael wrote: > A very common problem with online docs is fragmentation. Absolutely! Is it possible to include non-haddock documentation in a cabal package. Is it possible to have it readable on Hackage? I think this would help with the fragmentation and v

[Haskell-cafe] Re: Writing great documentation

2009-11-13 Thread Simon Michael
Thanks for this topic and the link; I'm going to try to use it to improve the docs for hledger and my other projects. (And I agree, he's wrong about auto-generated docs.) I seem to remember admiring Parsec's documentation. Though, that reminds me.. A very common problem with online docs is fra