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

Поиск
Список
Период
Сортировка
От Justin Clift
Тема Re: Interactive Documentation - how do you want it towork?
Дата
Msg-id 3E3E5A78.8040005@postgresql.org
обсуждение исходный текст
Ответ на Re: Interactive Documentation - how do you want it towork?  (Bruce Momjian <pgman@candle.pha.pa.us>)
Список pgsql-hackers
Bruce Momjian wrote:> I looked at that URL, and it is good example of what _not_ to do with> interactive docs, IMHO.
Themanual page is _very_ short, and shows no> examples.  The comments have various examples/cases, with corrections>
laterto earlier postings.  I would think this is not what we want. We> want a longer manual page, with _correct_
examplesthat show typical> usage.>> I know folks like those comments, but isn't it showing cases where the> curt
documentationjust 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




В списке pgsql-hackers по дате отправления:

Предыдущее
От: "Dave Page"
Дата:
Сообщение: Re: Interactive Documentation - how do you want it towork?
Следующее
От: Antti Haapala
Дата:
Сообщение: Re: On file locking