public inbox for [email protected]  

help / color / mirror / Atom feed

From: Robert Haas <[email protected]>
To: Craig Ringer <[email protected]>
Cc: David Johnston <[email protected]>
Cc: PostgreSQL Hackers <[email protected]>
Subject: Re: Add contrib module functions to docs' function index
Date: Wed, 14 Nov 2012 17:46:57 -0500
Message-ID: <CA+Tgmob7mUzmxjROiHsY4r2XE=iUzOxrpjuDVy7jsdi2tV=6zw@mail.gmail.com> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>
	<[email protected]>

On Tue, Nov 13, 2012 at 7:10 PM, Craig Ringer <[email protected]> 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

view thread (6+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Add contrib module functions to docs' function index
  In-Reply-To: <CA+Tgmob7mUzmxjROiHsY4r2XE=iUzOxrpjuDVy7jsdi2tV=6zw@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox