Re: Code examples - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: Code examples
Date
Msg-id 200709040229.29591.peter_e@gmx.net
Whole thread Raw
In response to Code examples  (Decibel! <decibel@decibel.org>)
Responses Re: Code examples  (Tom Lane <tgl@sss.pgh.pa.us>)
List 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 by date:

Previous
From: Decibel!
Date:
Subject: Code examples
Next
From: Tom Lane
Date:
Subject: Re: Code examples