From: "David Johnston" <polobo@yahoo.com>
To: "'Craig Ringer'" <craig@2ndQuadrant.com>,
	"'PostgreSQL Hackers'" <pgsql-hackers@postgresql.org>
References: <50A2D489.7020102@2ndQuadrant.com>
In-Reply-To: <50A2D489.7020102@2ndQuadrant.com>
Subject: Re: Add contrib module functions to docs' function index
Date: Tue, 13 Nov 2012 18:56:23 -0500
Message-ID: <002101cdc1fa$7c5a2640$750e72c0$@yahoo.com>
MIME-Version: 1.0
Content-Type: text/plain;
	charset="us-ascii"
Content-Transfer-Encoding: 7bit
Thread-Index: AQGJYqCMLvLCCaFuzQKKc/tzi8lxGZhxLjbA
Content-Language: en-us

> -----Original Message-----
> From: pgsql-hackers-owner@postgresql.org [mailto:pgsql-hackers-
> owner@postgresql.org] On Behalf Of Craig Ringer
> Sent: Tuesday, November 13, 2012 6:15 PM
> To: PostgreSQL Hackers
> Subject: [HACKERS] Add contrib module functions to docs' function index
> 
> Hi all
> 
> Andreas Heiduk on -bugs suggested that we add the functions provided by
> contrib modules to the function index in the docs, so it's easier to go
from,
> say,  "what the heck is idx(...)" to finding it in the intarray contrib
module.
> 
> This seems like a good idea and I'd like to pop it in the TODO until I get
time to
> check it out, flagged as a minor/newbie-friendly problem.
> Any objections?
> 

For clarity does this proposal refer to Chapter 9 of the documentation, the
"Index", or both.

If modifying Chapter 9 the function and operator tables should be extended
to include a "source" column with values of "base" or "contrib: <module
name>" or something similar.

As to the desirability of such a change I concur that it would be a nice
usability enhancement to consider beyond just updating the actual "Index".

David J.