Re: Toward better documentation

On Sun, Jul 18, 2004 at 10:14:23PM +0200, Peter Eisentraut wrote:
> David Fetter wrote:
> > It's been pointed out to me that I tend to document by example
>
> Documenting by example is like proving by example -- it helps
> understanding, but it doesn't replace the actual thing.
> Nonetheless, no one ever claimed that more examples would be a bad
> thing.

I see I have gotten off to a bad start here, and I apologize for not
having made myself clearer. I did not suggest removing the
"principles" items from the docs, nor did I suggest that anybody
thought examples are a bad thing.

What I am looking for is how the community feels about committing
resources, which are in short supply, to putting more examples in the
docs. I think this is a worthwhile effort, as it can pull in a larger
group of people to do documentation, taking some load off people who
do coding. :)

Cheers,
D
--
David Fetter david(at)fetter(dot)org http://fetter.org/
phone: +1 510 893 6100 mobile: +1 415 235 3778

Remember to vote!