Thread: Re: [COMMITTERS] pgsql: Add index entries for more functions

Re: [COMMITTERS] pgsql: Add index entries for more functions

From
Peter Eisentraut
Date:
On sön, 2010-11-28 at 23:59 +0000, Thom Brown wrote:
> Whilst looking at the latest build of the docs at
> http://developer.postgresql.org/pgdocs/postgres/bookindex.html I've
> noticed a discrepancy in this commit from the patch I provided.  I
> specified "average" as a primary term with "avg" as a secondary term,
> but the commit shows them both as separate primary entries.  Was this
> changed intentionally?

Yes.

I have no written reference for this, but from experience, my
understanding of the way index entries should work is that the primary
term is something you would look up, and the secondary term is something
you would look up among the primary terms.

So I think a reader would probably look up both "avg" because that's the
function he's using, and "average" because that's the term for what he's
trying to do.

Somewhat made up examples of what reasonable secondary terms might be:

avg,
   for user-defined types
   performance of



Re: [COMMITTERS] pgsql: Add index entries for more functions

From
Thom Brown
Date:
On 30 November 2010 17:55, Peter Eisentraut <peter_e@gmx.net> wrote:
> On sön, 2010-11-28 at 23:59 +0000, Thom Brown wrote:
>> Whilst looking at the latest build of the docs at
>> http://developer.postgresql.org/pgdocs/postgres/bookindex.html I've
>> noticed a discrepancy in this commit from the patch I provided.  I
>> specified "average" as a primary term with "avg" as a secondary term,
>> but the commit shows them both as separate primary entries.  Was this
>> changed intentionally?
>
> Yes.
>
> I have no written reference for this, but from experience, my
> understanding of the way index entries should work is that the primary
> term is something you would look up, and the secondary term is something
> you would look up among the primary terms.
>
> So I think a reader would probably look up both "avg" because that's the
> function he's using, and "average" because that's the term for what he's
> trying to do.
>
> Somewhat made up examples of what reasonable secondary terms might be:
>
> avg,
>   for user-defined types
>   performance of

Okay, fair enough. :)

--
Thom Brown
Twitter: @darkixion
IRC (freenode): dark_ixion
Registered Linux user: #516935