Re: Interactive Documentation - how do you want it towork?

From: Justin Clift <justin(at)postgresql(dot)org>
To: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>
Cc: Dave Page <dpage(at)vale-housing(dot)co(dot)uk>, Neil Conway <neilc(at)samurai(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Interactive Documentation - how do you want it towork?
Date: 2003-02-03 12:03:04
Message-ID: 3E3E5A78.8040005@postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Bruce Momjian wrote:
> I looked at that URL, and it is good example of what _not_ to do with
> interactive docs, IMHO. The manual page is _very_ short, and shows no
> examples. The comments have various examples/cases, with corrections
> later to earlier postings. I would think this is not what we want. We
> want a longer manual page, with _correct_ examples that show typical
> usage.
>
> I know folks like those comments, but isn't it showing cases where the
> curt documentation just doesn't cut it?

Bruce is spot on here. Manuals pages that don't need an extensive
amount of comments are likely the best way to go, and they're even
distributed with the source code of PostgreSQL, unlike the comments.

:-)

Regards and best wishes,

Justin Clift

--
"My grandfather once told me that there are two kinds of people: those
who work and those who take the credit. He told me to try to be in the
first group; there was less competition there."
- Indira Gandhi

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Antti Haapala 2003-02-03 12:10:49 Re: On file locking
Previous Message Dave Page 2003-02-03 12:01:32 Re: Interactive Documentation - how do you want it towork?