Re: [COMMITTERS] pgsql: Add index entries for more functions - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: [COMMITTERS] pgsql: Add index entries for more functions
Date
Msg-id 1291139748.13957.6.camel@vanquo.pezone.net
Whole thread Raw
Responses Re: [COMMITTERS] pgsql: Add index entries for more functions  (Thom Brown <thom@linux.com>)
List pgsql-docs
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



pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: [PATCH] Fix documentation about PL/Python exception handling
Next
From: Thom Brown
Date:
Subject: Re: [COMMITTERS] pgsql: Add index entries for more functions