pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Alvaro Herrera <alvherre@commandprompt.com>
To: Thom Brown <thom@linux.com>
Cc: pgsql-docs <pgsql-docs@postgresql.org>
Subject: Re: Inconsistent index links
Date: Wed, 01 Sep 2010 14:57:28 -0400
Message-ID: <1283366481-sup-7789@alvh.no-ip.org> (raw)
In-Reply-To: <AANLkTimHNx4nyNWyuFgRV09MdgF2YV6pZpzjCqz_9cRg@mail.gmail.com>
References: <AANLkTimHNx4nyNWyuFgRV09MdgF2YV6pZpzjCqz_9cRg@mail.gmail.com>

Excerpts from Thom Brown's message of mié sep 01 14:21:59 -0400 2010:
> Hi all,
> 
> 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.

+1 on using different titles.  No opinion your particular suggestion,
but the TOC on the tutorial needs to be consistent as well.

> 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).

I think we should have index entries for function names, aggregate or
not.  Perhaps <primary>avg</primary><secondary>aggregate function</> ?
Hmm, or maybe the other way around, so that all aggregates are listed
together in the index?  Not sure.  (but surely we don't want to have all
functions lumped together in a single "<primary>function</>").

For some reason I don't like <primary>average</><secondary>avg</>, but
then I don't like the current <primary>average</> either.

> 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.

Confusing index entries favor no one.  +1 for fixes you can suggest.

-- 
Álvaro Herrera <alvherre@commandprompt.com>
The PostgreSQL Company - Command Prompt, Inc.
PostgreSQL Replication, Consulting, Custom Development, 24x7 support



view thread (4+ messages)  latest in thread

Message-ID: <1283366481-sup-7789@alvh.no-ip.org>
Permalink:  ../1283366481-sup-7789@alvh.no-ip.org/
Also on:    postgresql.org/message-id/1283366481-sup-7789@alvh.no-ip.org

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: alvherre@commandprompt.com, thom@linux.com
  Subject: Re: Inconsistent index links
  In-Reply-To: <1283366481-sup-7789@alvh.no-ip.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox