Date: Tue, 20 Nov 2018 11:52:42 -0300
From: Alvaro Herrera <alvherre@2ndquadrant.com>
To: "Jonathan S. Katz" <jkatz@postgresql.org>
Cc: Bruce Momjian <bruce@momjian.us>, emilioplatzer@gmail.com,
	pgsql-docs@lists.postgresql.org
Subject: Re: Documentation for create unique index is insuficient and
 (because of that) incorrect
Message-ID: <20181120145242.mcvpzzb7od734p7v@alvherre.pgsql>
MIME-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <9ba37df7-156b-b983-65b5-85ed096818b9@postgresql.org>
User-Agent: NeoMutt/20180716
Precedence: bulk

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