Re: [PATCHES] Contrib docs v1

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: Albert Cervera i Areny <albert(at)nan-tic(dot)com>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: [PATCHES] Contrib docs v1
Date: 2007-11-11 19:29:35
Message-ID: 4963.1194809375@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-patches

Bruce Momjian <bruce(at)momjian(dot)us> writes:
> Tom Lane wrote:
>> What is the point of such a distinction?

> If the contrib value is the source code itself then it seems a README is
> more appropriate as people are not going to install the contrib module
> itself --- they are using it only to learn.

I find this argument pretty unconvincing. Most of the contrib modules
serve at least some purpose as coding examples.

If we set up a situation where all but one or two are documented in the
main SGML docs, the net effect will be that people don't even know that
the ones left out exist. Even a module that's only useful as an example
won't be useful at all, if people don't find it.

regards, tom lane

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2007-11-12 03:06:10 Re: [PATCHES] Contrib docs v1
Previous Message Bruce Momjian 2007-11-11 18:16:39 Re: [PATCHES] Contrib docs v1

Browse pgsql-patches by date

  From Date Subject
Next Message Tom Lane 2007-11-12 00:58:58 Re: tsearch2api .. wrapper for integrated fultext
Previous Message Bruce Momjian 2007-11-11 18:16:39 Re: [PATCHES] Contrib docs v1