From: Decibel! <decibel@decibel.org>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Oleg Bartunov <oleg@sai.msu.su>
Cc: Pavel Stehule <pavel.stehule@gmail.com>
Cc: pgsql-docs@postgresql.org
Subject: Code examples
Date: Mon, 3 Sep 2007 12:18:58 -0500
Message-ID: <20070903171858.GV38801@decibel.org> (raw)
In-Reply-To: <18259.1188773171@sss.pgh.pa.us>
References: <162867790709021328i7771aa9jfe79268bccbf123d@mail.gmail.com>
<Pine.LNX.4.64.0709030113090.2767@sn.sai.msu.ru>
<18259.1188773171@sss.pgh.pa.us>
Moving to -docs
On Sun, Sep 02, 2007 at 06:46:11PM -0400, Tom Lane wrote:
> > Another problem I see are broken examples of dictionary and parser in
> > documentation:
> > http://momjian.us/main/writings/pgsql/sgml/textsearch-rule-dictionary-example.html
> > http://momjian.us/main/writings/pgsql/sgml/textsearch-parser-example.html
>
> Yeah, I wanted to discuss that with you. Code examples in sgml docs are
> a bad idea: they're impossible to use as actual templates, because of
> all the weird markup changes, and there's no easy way to notice if
> they're broken. It would be better to remove these from the docs and
> set them up as contrib modules.
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?
I wrote some code that does this back when I was thinking about writing
a book, if anyone wants to see it.
--
Decibel!, aka Jim Nasby decibel@decibel.org
EnterpriseDB http://enterprisedb.com 512.569.9461 (cell)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: decibel@decibel.org, tgl@sss.pgh.pa.us, oleg@sai.msu.su, pavel.stehule@gmail.com
Subject: Re: Code examples
In-Reply-To: <20070903171858.GV38801@decibel.org>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox