[Haskell-cafe] Re: Documentation (was: ANN: text 0.5, a major
revision of the Unicode text library)
korpios at korpios.com
Mon Oct 19 17:49:53 EDT 2009
On Mon, Oct 19, 2009 at 4:32 PM, Kyle Murphy <orclev at gmail.com> wrote:
> If they have to spend three hours trying to track down some obscure
> research paper that's referenced in your documentation a half dozen times
> in as many functions, you're not providing enough detail and assuming too
> great a knowledge of the domain.
Even just a paragraph or two giving some background information and
example use cases would help immensely here; sometimes I just want to
quickly assess whether a library might be useful for solving a
particular problem, and "go read this paper" stops me cold.
More information about the Haskell-Cafe