Re: [HACKERS] Add contrib module functions to docs' function index

On Tue, Jul 2, 2013 at 03:56:10PM -0400, Bruce Momjian wrote:
> On Wed, Nov 14, 2012 at 05:46:57PM -0500, Robert Haas wrote:
> > 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.
>
> Seems we never considered index entries when we moved the contrib
> information into our main docs.
>
> I have developed the this patch to do this. I would like to apply
> this to head and 9.3:
>
> http://momjian.us/expire/contrib.diff

Applied, and backpatched to 9.3. Craig, thanks for the suggestion.

--
Bruce Momjian <bruce(at)momjian(dot)us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ It's impossible for everything to be true. +