3 ms·
"... There is one minor detail... Unfortunately, the documentation for HAppS is cringeworthy ..." Nothing kills the urge to learn something quicker than incomp
by bootload 18y ago
"... There is one minor detail... Unfortunately, the documentation for HAppS is cringeworthy ..."
Nothing kills the urge to learn something quicker than incomplete docs. But it doesn't have to be this way. John Resig of JDoc fame, gets around this problem by concentrating on writing good documentation of the core API ~ http://blog.jquery.com/2006/09/02/taking-jquery-documentation-to-the-next-level/ http://blog.jquery.com/2006/09/02/taking-jquery-documentatio... (along with doing stacks of talks, demos) leaving the gaps for others to fill ~ http://www.html.it/articoli/johnresig/index.html http://www.html.it/articoli/johnresig/index.html
- tphyahoo 18y agoI totally agree. It's not really a "minor detail." There's a "getting organized" thread on the happs googlegroup about this at the moment, and I really hope it bears fruit. This should be done via haddock of course, but haddock won't build HAppS documentation at the moment because it doesn't work with template haskell (as discussed in the googlegroup). Optimistically, this should be working again after ghc 6.10.2, which also targets a haddock fix. Even without working haddock though, the api should be better documented in the source. If haddock suddenly started working there still would be a lot of undocumented functions.