MIME-Version: 1.0
References: <157855848580.29169.11958103978637887119@wrigleys.postgresql.org>
 <6E6064A4-D57B-4DF0-A0BF-4DFA745ACD47@yesql.se>
In-Reply-To: <6E6064A4-D57B-4DF0-A0BF-4DFA745ACD47@yesql.se>
From: Magnus Hagander <magnus@hagander.net>
Date: Thu, 9 Jan 2020 10:50:14 +0100
Message-ID: 
 <CABUevEzvLn9fKoVZdoAvhbGg1Eqfy7JQuX79gpP5VsOOVKrjVg@mail.gmail.com>
Subject: Re: Suggestion on Document for Version 12 Section 40.3
To: Daniel Gustafsson <daniel@yesql.se>
Cc: zhangysh1995@gmail.com, Pg Docs <pgsql-docs@lists.postgresql.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Thu, Jan 9, 2020 at 10:42 AM Daniel Gustafsson <daniel@yesql.se> wrote:
>
> > On 9 Jan 2020, at 09:28, PG Doc comments form <noreply@postgresql.org> wrote:
> >
> > The following documentation comment has been logged on the website:
> >
> > Page: https://www.postgresql.org/docs/12/rules-materializedviews.html
> > Description:
> >
> > Hello all,
> >
> >
> > I'm reading Section 40.3, and there is an example (the third square by
> > reverse order):
> >
> >
> > SELECT word FROM words ORDER BY word <-> 'caterpiler' LIMIT 10;
> >
> >     word
> > ---------------
> > cater
> > caterpillar
> > Caterpillar
> > caterpillars
> > caterpillar's
> > Caterpillar's
> > caterer
> > caterer's
> > caters
> > catered
> > (10 rows)
> >
> >
> > As shown here https://www.postgresql.org/docs/current/pgtrgm.html, the
> > operator `<->` is in an additional module. Without the context, the reader
> > will need searching to help understand the meaning. It would be better if
> > further reference is given.
>
> I agree that this could lead to unnecessary confusion for readers, and since we
> are already mentioning that file_fdw is used it seems reasonable to also
> mention pg_trgm.  A suggested patch is attached.

Seems correct. Pushed, thanks!

//Magnus