Re: Optimizing the documentation

Поиск
Список
Период
Сортировка
От Peter Geoghegan
Тема Re: Optimizing the documentation
Дата
Msg-id CAH2-WzkM8qq9W2CYmz841YNsdz466Qdqh-jRZBiJCC0o907YRQ@mail.gmail.com
обсуждение исходный текст
Ответ на Re: Optimizing the documentation  (Bruce Momjian <bruce@momjian.us>)
Список pgsql-hackers
On Thu, Dec 17, 2020 at 7:42 AM Bruce Momjian <bruce@momjian.us> wrote:
> I agree a holistic review of the docs can yield great benefits.  No one
> usually complains about overly verbose text, but making it clearer is
> always a win.  Anyway, of course, it is going to be very specific for
> each case.  As an extreme example, in 2007 when I did a full review of
> the docs, I clarified may/can/might in our docs, and it probably helped.

I think that the "may/can/might" rule is a very good one. It
standardizes something that would otherwise just be left to chance,
and AFAICT has no possible downside. Even still, I think that adding
new rules is subject to sharp diminishing returns. There just aren't
that many things that work like that.

-- 
Peter Geoghegan



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

Предыдущее
От: Peter Geoghegan
Дата:
Сообщение: Re: [PATCH] nbtree: Do not show debugmessage if deduplication is disabled
Следующее
От: Tom Lane
Дата:
Сообщение: Re: [HACKERS] [PATCH] Generic type subscripting