Re: Add contrib module functions to docs' function index

From: "David Johnston" <polobo(at)yahoo(dot)com>
To: "'Craig Ringer'" <craig(at)2ndQuadrant(dot)com>, "'PostgreSQL Hackers'" <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Add contrib module functions to docs' function index
Date: 2012-11-13 23:56:23
Message-ID: 002101cdc1fa$7c5a2640$750e72c0$@yahoo.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

> -----Original Message-----
> From: pgsql-hackers-owner(at)postgresql(dot)org [mailto:pgsql-hackers-
> owner(at)postgresql(dot)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.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Craig Ringer 2012-11-14 00:10:27 Re: Add contrib module functions to docs' function index
Previous Message Craig Ringer 2012-11-13 23:15:21 Add contrib module functions to docs' function index

Browse pgsql-hackers by date

  From Date Subject
Next Message Bruce Momjian 2012-11-14 00:03:51 Re: Further pg_upgrade analysis for many tables
Previous Message Craig Ringer 2012-11-13 23:15:21 Add contrib module functions to docs' function index