public inbox for [email protected]help / color / mirror / Atom feed
Add contrib module functions to docs' function index 6+ messages / 4 participants [nested] [flat]
* Add contrib module functions to docs' function index @ 2012-11-13 23:15 Craig Ringer <[email protected]> 0 siblings, 1 reply; 6+ messages in thread From: Craig Ringer @ 2012-11-13 23:15 UTC (permalink / raw) To: PostgreSQL Hackers <[email protected]> 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? -- Craig Ringer http://www.2ndQuadrant.com/ PostgreSQL Development, 24x7 Support, Training & Services ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Add contrib module functions to docs' function index @ 2012-11-13 23:56 David Johnston <[email protected]> parent: Craig Ringer <[email protected]> 0 siblings, 1 reply; 6+ messages in thread From: David Johnston @ 2012-11-13 23:56 UTC (permalink / raw) To: 'Craig Ringer' <[email protected]>; 'PostgreSQL Hackers' <[email protected]> > -----Original Message----- > From: [email protected] [mailto:pgsql-hackers- > [email protected]] 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. ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Add contrib module functions to docs' function index @ 2012-11-14 00:10 Craig Ringer <[email protected]> parent: David Johnston <[email protected]> 0 siblings, 1 reply; 6+ messages in thread From: Craig Ringer @ 2012-11-14 00:10 UTC (permalink / raw) To: David Johnston <[email protected]>; +Cc: 'PostgreSQL Hackers' <[email protected]> On 11/14/2012 07:56 AM, David Johnston wrote: > > 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". Sorry I was unclear. 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 <http://www.postgresql.org/docs/9.2/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. 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>". -- Craig Ringer http://www.2ndQuadrant.com/ PostgreSQL Development, 24x7 Support, Training & Services ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: Add contrib module functions to docs' function index @ 2012-11-14 22:46 Robert Haas <[email protected]> parent: Craig Ringer <[email protected]> 0 siblings, 1 reply; 6+ messages in thread From: Robert Haas @ 2012-11-14 22:46 UTC (permalink / raw) To: Craig Ringer <[email protected]>; +Cc: David Johnston <[email protected]>; PostgreSQL Hackers <[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 ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: [HACKERS] Add contrib module functions to docs' function index @ 2013-07-02 19:56 Bruce Momjian <[email protected]> parent: Robert Haas <[email protected]> 0 siblings, 1 reply; 6+ messages in thread From: Bruce Momjian @ 2013-07-02 19:56 UTC (permalink / raw) To: Robert Haas <[email protected]>; +Cc: Craig Ringer <[email protected]>; David Johnston <[email protected]>; pgsql-docs On Wed, Nov 14, 2012 at 05:46:57PM -0500, Robert Haas wrote: > 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. 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 -- Bruce Momjian <[email protected]> http://momjian.us EnterpriseDB http://enterprisedb.com + It's impossible for everything to be true. + -- Sent via pgsql-docs mailing list ([email protected]) To make changes to your subscription: http://www.postgresql.org/mailpref/pgsql-docs ^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: [HACKERS] Add contrib module functions to docs' function index @ 2013-07-04 15:33 Bruce Momjian <[email protected]> parent: Bruce Momjian <[email protected]> 0 siblings, 0 replies; 6+ messages in thread From: Bruce Momjian @ 2013-07-04 15:33 UTC (permalink / raw) To: Robert Haas <[email protected]>; +Cc: Craig Ringer <[email protected]>; David Johnston <[email protected]>; pgsql-docs 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 <[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. > > 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 <[email protected]> http://momjian.us EnterpriseDB http://enterprisedb.com + It's impossible for everything to be true. + -- Sent via pgsql-docs mailing list ([email protected]) To make changes to your subscription: http://www.postgresql.org/mailpref/pgsql-docs ^ permalink raw reply [nested|flat] 6+ messages in thread
end of thread, other threads:[~2013-07-04 15:33 UTC | newest] Thread overview: 6+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2012-11-13 23:15 Add contrib module functions to docs' function index Craig Ringer <[email protected]> 2012-11-13 23:56 ` David Johnston <[email protected]> 2012-11-14 00:10 ` Craig Ringer <[email protected]> 2012-11-14 22:46 ` Robert Haas <[email protected]> 2013-07-02 19:56 ` Bruce Momjian <[email protected]> 2013-07-04 15:33 ` Bruce Momjian <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox