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

From Bruce Momjian
Subject Re: [PATCHES] Contrib docs v1
Date
Msg-id 200711111816.lABIGdU15448@momjian.us
Whole thread Raw
In response to Re: [PATCHES] Contrib docs v1  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: [PATCHES] Contrib docs v1  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-docs
Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > Uh, don't start converting them yet.  I now realize that
> > /contrib/dict_int is an example and just like the stuff in /contrib/spi
> > perhaps shouldn't have its docs moved to SGML.
>
> What makes you realize any such thing?  You could make that argument for
> test_parser, probably, but the dict modules are useful in their own
> right.
>
> > Should we leave example /contrib modules documented in READMEs?
>
> 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.

--
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://postgres.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +

pgsql-docs by date:

Previous
From: Tom Lane
Date:
Subject: Re: [PATCHES] Contrib docs v1
Next
From: Tom Lane
Date:
Subject: Re: [PATCHES] Contrib docs v1