Re: [PATCHES] Contrib docs v1 - Mailing list pgsql-docs

From Tom Lane
Subject Re: [PATCHES] Contrib docs v1
Date
Msg-id 4963.1194809375@sss.pgh.pa.us
Whole thread Raw
In response to Re: [PATCHES] Contrib docs v1  (Bruce Momjian <bruce@momjian.us>)
Responses Re: [PATCHES] Contrib docs v1
List pgsql-docs
Bruce Momjian <bruce@momjian.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

pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: [PATCHES] Contrib docs v1
Next
From: Bruce Momjian
Date:
Subject: Re: [PATCHES] Contrib docs v1