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

Code examples

From: Decibel! <decibel(at)decibel(dot)org>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Oleg Bartunov <oleg(at)sai(dot)msu(dot)su>,Pavel Stehule <pavel(dot)stehule(at)gmail(dot)com>, pgsql-docs(at)postgresql(dot)org
Subject: Code examples
Date: 2007-09-03 17:18:58
Message-ID: 20070903171858.GV38801@decibel.org (view raw or flat)
Thread:
Lists: pgsql-docspgsql-hackers
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(at)decibel(dot)org
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)

In response to

Responses

pgsql-docs by date

Next:From: Florian PflugDate: 2007-09-03 18:01:08
Subject: Re: tsearch filenames unlikes special symbols and numbers
Previous:From: Trevor TalbotDate: 2007-09-03 17:02:50
Subject: Re: tsearch filenames unlikes special symbols and numbers

pgsql-hackers by date

Next:From: Florian G. PflugDate: 2007-09-03 17:33:22
Subject: Re: Per-function GUC settings: trickier than it looked
Previous:From: Kenneth MarshallDate: 2007-09-03 17:18:08
Subject: Re: Hash index todo list item

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