pgsql: Add index entries for more functions

Started by Peter Eisentrautover 15 years ago4 messagesdocs
Jump to latest
#1Peter Eisentraut
peter_e@gmx.net

Add index entries for more functions

Also, move index entries into the tables, closer to the function description,
for easier editing in the future. Resort some tables to be more alphabetical.
Remove the entries for count, max, min, and sum in the tutorial area, because
that was felt to be confusing.

Thom Brown

Branch
------
master

Details
-------
http://git.postgresql.org/gitweb?p=postgresql.git;a=commitdiff;h=4fc09ad00c3cc95003a5523d85999da1dd4f9d75

Modified Files
--------------
doc/src/sgml/func.sgml | 1781 ++++++++++++++++++++++++++++++-----------------
doc/src/sgml/query.sgml | 6 -
2 files changed, 1141 insertions(+), 646 deletions(-)

#2Thom Brown
thom@linux.com
In reply to: Peter Eisentraut (#1)
Re: pgsql: Add index entries for more functions

On 23 November 2010 22:03, Peter Eisentraut <peter_e@gmx.net> wrote:

Add index entries for more functions

Also, move index entries into the tables, closer to the function description,
for easier editing in the future.  Resort some tables to be more alphabetical.
Remove the entries for count, max, min, and sum in the tutorial area, because
that was felt to be confusing.

Thom Brown

Branch
------
master

Details
-------
http://git.postgresql.org/gitweb?p=postgresql.git;a=commitdiff;h=4fc09ad00c3cc95003a5523d85999da1dd4f9d75

Modified Files
--------------
doc/src/sgml/func.sgml  | 1781 ++++++++++++++++++++++++++++++-----------------
doc/src/sgml/query.sgml |    6 -
2 files changed, 1141 insertions(+), 646 deletions(-)

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?

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

#3Peter Eisentraut
peter_e@gmx.net
In reply to: Thom Brown (#2)
Re: [COMMITTERS] pgsql: Add index entries for more functions

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

#4Thom Brown
thom@linux.com
In reply to: Peter Eisentraut (#3)
Re: [COMMITTERS] pgsql: Add index entries for more functions

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