Re: [Haskell-cafe] On documentation

2010-08-12 Thread David Waern
2010/7/23 Ivan Miljenovic : > On 22 July 2010 18:33, David Waern wrote: > > [snip] > >> We currently only support concrete examples (i.e. unit tests), but the >> plan is to add support for QuickCheck properties. > > Would you have some kind of inbuilt time limit (similar to what mueval > has) for

Re: [Haskell-cafe] On documentation

2010-07-22 Thread Ivan Miljenovic
On 22 July 2010 18:33, David Waern wrote: [snip] > We currently only support concrete examples (i.e. unit tests), but the > plan is to add support for QuickCheck properties. Would you have some kind of inbuilt time limit (similar to what mueval has) for very long/complex QC tests? I have some

Re: [Haskell-cafe] On documentation

2010-07-22 Thread Andrew Coppin
Alexander Solla wrote: After all, the source is always structured in more-or-less the same way. Fragments of text with opaque -- unless/until you understand them -- combinators "join" two distinct concepts/types into functions. A chain of functions (potentially at various levels of abstract

Re: [Haskell-cafe] On documentation

2010-07-22 Thread wren ng thornton
David Waern wrote: 2010/7/21 Richard O'Keefe : One of the really nice ideas in the R statistics system is that documentation pages can contain executable examples, and when you wrap up a package for distribution, the system checks that the examples run as advertised. The next version of Haddoc

Re: [Haskell-cafe] On documentation

2010-07-22 Thread David Waern
2010/7/21 Richard O'Keefe : > One of the really nice ideas in the R statistics system is that > documentation pages can contain executable examples, and when you > wrap up a package for distribution, the system checks that the > examples run as advertised. The next version of Haddock will support

Re: [Haskell-cafe] On documentation

2010-07-21 Thread Alexander Solla
On Jul 20, 2010, at 10:28 PM, Richard O'Keefe wrote: What I don't see is "HOW DO I USE THIS STUFF?" I think tutorials are the best way to do that (i.e., example normal forms for the computations the library intends to expose). Perl's package archive (the cpan) traditionally uses a "Synop

Re: [Haskell-cafe] On documentation

2010-07-21 Thread Andrew Coppin
Ivan Miljenovic wrote: * When writing the code, it's obvious what it does; as such you may think any documentation you may offer is trivial (down the track, however...). * The author is familiar with a library; as such it may not be obvious what extra documentation could be needed. This is the

Re: [Haskell-cafe] On documentation

2010-07-20 Thread Ivan Miljenovic
On 21 July 2010 15:28, Richard O'Keefe wrote: > I'm giving some lectures this week about how to _read_ programs, > and I've had some things to say about JavaDoc and wondered whether > to show some examples of Haddock. > > I took a certain library that has been mentioned recently in > this mailing

[Haskell-cafe] On documentation

2010-07-20 Thread Richard O'Keefe
I'm giving some lectures this week about how to _read_ programs, and I've had some things to say about JavaDoc and wondered whether to show some examples of Haddock. I took a certain library that has been mentioned recently in this mailing list. (I shall not identify it. The author deserves pra