Re: Code examples

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Alvaro Herrera <alvherre(at)commandprompt(dot)com>
Cc: Peter Eisentraut <peter_e(at)gmx(dot)net>, pgsql-docs(at)postgresql(dot)org, Decibel! <decibel(at)decibel(dot)org>, 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 16:19:14
Message-ID: 26291.1188922754@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Alvaro Herrera <alvherre(at)commandprompt(dot)com> writes:
> Maybe we could set things up so that there are actual files which are
> programatically preprocessed to SGML to be included in the docs? That
> way, the docs always reflect the actual file, which by itself is
> compilable. The SGML source would only contain something like
> <include file="examples/foo.c" /> or something like that.

Well, if we have actual contrib modules (which is still a good idea
so that they get tested on a regular basis), I don't see any need to
copy the code into the docs at all. The docs should just say "a working
example can be found in contrib/whatever".

regards, tom lane

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Oleg Bartunov 2007-09-04 16:37:47 Re: Code examples
Previous Message Ben Tilly 2007-09-04 15:38:28 Re: tsearch filenames unlikes special symbols and numbers

Browse pgsql-hackers by date

  From Date Subject
Next Message Cédric Villemain 2007-09-04 16:22:35 pg_dump and insert multi-rows option
Previous Message Dave Page 2007-09-04 15:50:17 Re: Has anyone tried out the PL/pgSQL debugger?