Skip site navigation (1) Skip section navigation (2)

Re: Code examples

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: pgsql-docs(at)postgresql(dot)org
Cc: Decibel! <decibel(at)decibel(dot)org>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Oleg Bartunov <oleg(at)sai(dot)msu(dot)su>, Pavel Stehule <pavel(dot)stehule(at)gmail(dot)com>
Subject: Re: Code examples
Date: 2007-09-04 00:29:28
Message-ID: 200709040229.29591.peter_e@gmx.net (view raw or flat)
Thread:
Lists: pgsql-docspgsql-hackers
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/

In response to

Responses

pgsql-docs by date

Next:From: Tom LaneDate: 2007-09-04 00:39:54
Subject: Re: Code examples
Previous:From: Tom LaneDate: 2007-09-04 00:03:26
Subject: Re: tsearch filenames unlikes special symbols and numbers

pgsql-hackers by date

Next:From: Tom LaneDate: 2007-09-04 00:34:14
Subject: Re: Hash index todo list item
Previous:From: Kenneth MarshallDate: 2007-09-04 00:27:31
Subject: Re: Hash index todo list item

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group