Received: from localhost (unknown [200.46.204.187]) by postgresql.org (Postfix) with ESMTP id 80AC29F9A3D for ; Mon, 3 Sep 2007 14:19:19 -0300 (ADT) Received: from postgresql.org ([200.46.204.71]) by localhost (mx1.hub.org [200.46.204.187]) (amavisd-maia, port 10024) with ESMTP id 71737-09 for ; Mon, 3 Sep 2007 14:19:02 -0300 (ADT) X-Greylist: from auto-whitelisted by SQLgrey-1.7.5 Received: from noel.decibel.org (noel.decibel.org [67.100.216.10]) by postgresql.org (Postfix) with ESMTP id 3CA8C9F984F for ; Mon, 3 Sep 2007 14:19:09 -0300 (ADT) Received: by noel.decibel.org (Postfix, from userid 1001) id A0B46564BE; Mon, 3 Sep 2007 17:19:03 +0000 (UTC) Received: (hashcash-sendmail, from uid 1001); Mon, 3 Sep 2007 12:18:59 -0500 Date: Mon, 3 Sep 2007 12:18:58 -0500 From: Decibel! To: Tom Lane Cc: Oleg Bartunov , Pavel Stehule , pgsql-docs@postgresql.org Subject: Code examples Message-ID: <20070903171858.GV38801@decibel.org> References: <162867790709021328i7771aa9jfe79268bccbf123d@mail.gmail.com> <18259.1188773171@sss.pgh.pa.us> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="Yc07lwn3HUDqPfE2" Content-Disposition: inline In-Reply-To: <18259.1188773171@sss.pgh.pa.us> X-Operating-System: FreeBSD 6.1-RELEASE-p10 amd64 X-Distributed: Join the Effort! http://www.distributed.net User-Agent: Mutt/1.5.13 (2006-08-11) X-Hashcash: 1:20:070903:tgl@sss.pgh.pa.us::Rvn3jlArYiVORyGQ:00000000000000000000 0000000000000000000000001ecb X-Hashcash: 1:20:070903:oleg@sai.msu.su::690jofaWALfsJu5R:001Ib8 X-Hashcash: 1:20:070903:pavel.stehule@gmail.com::li6l0gNIAFewcAXa:00000000000000 00000000000000000000000036q4 X-Hashcash: 1:20:070903:pgsql-docs@postgresql.org::ROjfFE+g+5ZDBaVr:000000000000 000000000000000000000000094Y X-Virus-Scanned: Maia Mailguard 1.0.1 X-Archive-Number: 200709/1 X-Sequence-Number: 4399 --Yc07lwn3HUDqPfE2 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable 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= =20 > > documentation: > > http://momjian.us/main/writings/pgsql/sgml/textsearch-rule-dictionary-e= xample.html > > http://momjian.us/main/writings/pgsql/sgml/textsearch-parser-example.ht= ml >=20 > 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. --=20 Decibel!, aka Jim Nasby decibel@decibel.org EnterpriseDB http://enterprisedb.com 512.569.9461 (cell) --Yc07lwn3HUDqPfE2 Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.3 (FreeBSD) iD8DBQFG3EICdO30qud8SkgRAoLRAKCrqcGn2XLL6D/kZIPdV/K5F10PbgCfbvHo PE4zwTUSYL5CcyQfkVW1pgo= =HlUc -----END PGP SIGNATURE----- --Yc07lwn3HUDqPfE2--