Mike Orr wrote:

>On Thu, Nov 11, 2004 at 07:37:08PM +0300, Oleg Broytmann wrote:
>
>
>>   Yes. The code is the only doc. For any project, not only for Quixote.
>>
>>
>
>That's fine if you never upgrade, but code is subject to incompatible
>changes.  You don't know which features the developers consider
>fundamental and which are accidental.  Documentation is essentially a
>contract between the developer and the user, saying this is the
>recommended usage, and this API will not change without good reason and
>upgrade advice.  Comments in the code could serve the same purpose, but
>in practice they usually don't.  Documentation also serves to integrate
>modules and show how they work together.
>
>
I smell a documentation-writing volunteer... Neil, fetch the nets --
before he gets away!  ;-)

Seriously: perhaps moving the Quixote documentation to the Wiki would be
a good idea. Then, "write it yourself" would be a decent and meaningful
reponse to "the documentation is lacking".

-- G