On Sun, Jun 04, 2006 at 07:36:34PM -0400, brian@surge.insomnia.org wrote:
> On Sun, 4 Jun 2006, Thor Lancelot Simon wrote:
> 
> >Unfortunately, often the only easy way to give an adequate explanation of
> >"what does this API" do -- when "how long does it take/how much memory
> >does it use" are considered part of what it "does", which for code like
> >sorting or hashing code it's simply insane not to -- is to answer the
> >question of "how it works".  This, in fact, is exactly such a case.
> 
> The source already answers that question, though. Do you really think it's 
> a good idea to document things in multiple places?

Yes, because the source code is the source code; it is not, in any
reasonable sense of the word, "documentation".

Thor