Re: Add contrib module functions to docs' function index

From: Robert Haas <robertmhaas(at)gmail(dot)com>
To: Craig Ringer <craig(at)2ndquadrant(dot)com>
Cc: David Johnston <polobo(at)yahoo(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Add contrib module functions to docs' function index
Date: 2012-11-14 22:46:57
Message-ID: CA+Tgmob7mUzmxjROiHsY4r2XE=iUzOxrpjuDVy7jsdi2tV=6zw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

On Tue, Nov 13, 2012 at 7:10 PM, Craig Ringer <craig(at)2ndquadrant(dot)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

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Jeff Janes 2012-11-21 18:09:15 8.4 doc bug for "Incrementally Updated Backups"
Previous Message Louis-Claude Canon 2012-11-14 21:19:39 Re: Incomplete compatibility information for triggers

Browse pgsql-hackers by date

  From Date Subject
Next Message Bruce Momjian 2012-11-14 22:58:14 Re: pgsql: In pg_upgrade, copy fsm, vm, and extent files by checking for fi
Previous Message Tom Lane 2012-11-14 22:39:29 Re: pgsql: In pg_upgrade, copy fsm, vm, and extent files by checking for fi