Re: Code examples

Поиск
Список
Период
Сортировка
От Peter Eisentraut
Тема Re: Code examples
Дата
Msg-id 200709040229.29591.peter_e@gmx.net
обсуждение исходный текст
Ответ на Code examples  (Decibel! <decibel@decibel.org>)
Ответы Re: Code examples  (Tom Lane <tgl@sss.pgh.pa.us>)
Список pgsql-docs
Decibel! wrote:
> Couldn't we come up with some method of specifying code examples in
> the docs and then having the doc build process actually run those
> examples and put that into the doc build?

While that seems very tempting, I think you need manual review to check
whether the examples make didactic sense.  For example, I seem to
recall that we had to change some examples about how operator
precendence or type casting gives unexpected results several times over
the years because the unexpected results had turned into expected
results in response to new features.  If you'd just produce the
documentation examples automatically, you'd be left with quite
embarrassing nonsense in there.

--
Peter Eisentraut
http://developer.postgresql.org/~petere/

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

Предыдущее
От: Decibel!
Дата:
Сообщение: Code examples
Следующее
От: Tom Lane
Дата:
Сообщение: Re: Code examples