Re: Add contrib module functions to docs' function index - Mailing list pgsql-hackers

From Robert Haas
Subject Re: Add contrib module functions to docs' function index
Date
Msg-id CA+Tgmob7mUzmxjROiHsY4r2XE=iUzOxrpjuDVy7jsdi2tV=6zw@mail.gmail.com
Whole thread Raw
In response to Re: Add contrib module functions to docs' function index  (Craig Ringer <craig@2ndQuadrant.com>)
List pgsql-hackers
On Tue, Nov 13, 2012 at 7:10 PM, Craig Ringer <craig@2ndquadrant.com> wrote:
> I'm talking about making sure that contrib module functions (and settings)
> appear in the documentation index (
> http://www.postgresql.org/docs/current/static/bookindex.html) so it's easy
> to find a function by name whether it's in core or contrib. This is what I
> want to add to TODO.

+1.

> Separately, it might also be nice to add the contrib functions to the
> section 9 tables with an extra column showing their origin, but that's less
> clearly a good thing. Even if there's a column saying "intarray" for
> intarray functions in the array functions list, people will still try to use
> them without loading the extension and get confused when they're not found.
> It'll also bloat the listings of core functions. Rather than do that, I'd
> probably prefer to add a note to relevant sections. For example, in array
> functions I'd want to add "Additional functions that operate only on arrays
> of integers are available in the <a href="...">intarray extension</a>".

The second approach seems better, and maybe only in cases where it's
particularly relevant.

-- 
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company



pgsql-hackers by date:

Previous
From: Robert Haas
Date:
Subject: Re: My first patch! (to \df output)
Next
From: Jeff Davis
Date:
Subject: Re: Enabling Checksums