Thread: 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? -- Craig Ringer http://www.2ndQuadrant.com/PostgreSQL Development, 24x7 Support, Training & Services
> -----Original Message----- > From: pgsql-hackers-owner@postgresql.org [mailto:pgsql-hackers- > owner@postgresql.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.
<div class="moz-cite-prefix">On 11/14/2012 07:56 AM, David Johnston wrote:<br /></div><blockquote cite="mid:002101cdc1fa$7c5a2640$750e72c0$@yahoo.com"type="cite"><br /><pre wrap="">For clarity does this proposal refer toChapter 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". </pre></blockquote> Sorry I was unclear.<br /><br /> I'm talking about making sure that contrib module functions (and settings)appear in the documentation index ( <a href="http://www.postgresql.org/docs/9.2/static/bookindex.html">http://www.postgresql.org/docs/current/static/bookindex.html</a>) soit's easy to find a function by name whether it's in core or contrib. This is what I want to add to TODO.<br /><br /> Separately,it might also be nice to add the contrib functions to the section 9 tables with an extra column showing theirorigin, but that's less clearly a good thing. Even if there's a column saying "intarray" for intarray functions in thearray functions list, people will still try to use them without loading the extension and get confused when they're notfound. It'll also bloat the listings of core functions. Rather than do that, I'd probably prefer to add a note to relevantsections. For example, in array functions I'd want to add "Additional functions that operate only on arrays of integersare available in the <a href="...">intarray extension</a>".<br /><pre class="moz-signature" cols="72">--Craig Ringer <a class="moz-txt-link-freetext" href="http://www.2ndQuadrant.com/">http://www.2ndQuadrant.com/</a>PostgreSQLDevelopment, 24x7 Support, Training & Services</pre>
On Tue, Nov 13, 2012 at 7:10 PM, Craig Ringer <craig@2ndquadrant.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