Re: Documentation for create unique index is insuficient and (because of that) incorrect

From: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
To: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>
Cc: Bruce Momjian <bruce(at)momjian(dot)us>, emilioplatzer(at)gmail(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Documentation for create unique index is insuficient and (because of that) incorrect
Date: 2018-11-20 14:52:42
Message-ID: 20181120145242.mcvpzzb7od734p7v@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 2018-Nov-20, Jonathan S. Katz wrote:

> On 11/19/18 9:05 PM, Bruce Momjian wrote:
> > On Tue, Oct 23, 2018 at 06:29:55PM +0000, PG Doc comments form wrote:
> >> The following documentation comment has been logged on the website:
> >>
> >> Page: https://www.postgresql.org/docs/11/static/indexes-unique.html
> >> Description:
> >>
> >> In https://www.postgresql.org/docs/11/static/indexes-unique.html there are
> >> omited clausules
> >>
> >> For example WHERE clausule is omited.
> >>
> >> In https://www.postgresql.org/docs/11/static/sql-createindex.html you can
> >> see the right sintax with all the clausules.
> >
> > The first URL is an example and is not intended to be the complete
> > syntax.

I think the OP should take a lengthier look at the whole of chapter 11
instead of looking at just one individual section within it. It's the
whole chapter that should include details about other indexing features
-- and indeed the WHERE clause is described in 11.8 Partial Indexes.

Describing every feature within the section for every other feature
would be disastrous.

> In fairness, the "INCLUDE" clause was added, which is new to PostgreSQL
> 11, so it could raise the question as to why aren't other clauses there.

IMO that's actually a bug -- the INCLUDE clause should have gotten its
own section in chapter 11 instead of being mentioned in the section
about unique indexes.

--
Álvaro Herrera https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2018-11-20 14:59:18 Re: Documentation for create unique index is insuficient and (because of that) incorrect
Previous Message Jonathan S. Katz 2018-11-20 14:41:56 Re: Documentation for create unique index is insuficient and (because of that) incorrect