Re: Inconsistent index links

From: Robert Haas <robertmhaas(at)gmail(dot)com>
To: Thom Brown <thom(at)linux(dot)com>
Cc: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Inconsistent index links
Date: 2010-09-25 13:50:00
Message-ID: AANLkTin_iFSQRuqyRQ08rxpABZ3_L6rWaW5AisDeCGnn@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Wed, Sep 1, 2010 at 2:21 PM, Thom Brown <thom(at)linux(dot)com> wrote:
> I noticed that all aggregate functions listed in the documentation
> index direct to a page listing all the aggregate functions and their
> usage, with the exception of count, max, min and sum, which direct to
> the aggregate function tutorial page.  From the index, these sections
> are indistinguishable from one another since they share the same page
> name.  I'm wondering if one should be named differently, like
> Aggregate Functions Tutorial.

Yeah, maybe. The thing is, many of the things in the tutorial-sql
chapter could be subject to similar confusion. Is there a way we can
make those show up differently in the index than they do in the table
of contents for that chapter?

> Also, any particular reason why those 4 aggregate functions go to a
> different place to all the others?

This just seems wildly inconsistent. I'd be inclined to make these
all point to the reference docs rather than the tutorial. Or else
point to both.

> The avg function is confusingly indexed only as "average", which
> shouldn't really be a problem... unless someone types in "avg" into
> their browser's find box.  Maybe this should have "average" as a
> primary term and "avg" as a secondary (with Pavel's 'median" function
> to be added later).

Sounds fine to me.

> But next to this "average" index entry are links
> to both the aggregate function sections, which are named identically.
> I raised a similar issue to this for "privileges" in the index
> previously.

This should be made consistent with whatever we do about the point two
paragraphs up.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise Postgres Company

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Eisentraut 2010-09-26 11:57:50 Re: ECPG - Some errno definitions don't match to the manual
Previous Message Robert Haas 2010-09-25 13:40:08 Re: Substring undocumented form