Re: Suggestion on Document for Version 12 Section 40.3

From: Magnus Hagander <magnus(at)hagander(dot)net>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: zhangysh1995(at)gmail(dot)com, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Suggestion on Document for Version 12 Section 40.3
Date: 2020-01-09 09:50:14
Message-ID: CABUevEzvLn9fKoVZdoAvhbGg1Eqfy7JQuX79gpP5VsOOVKrjVg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Thu, Jan 9, 2020 at 10:42 AM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
>
> > On 9 Jan 2020, at 09:28, PG Doc comments form <noreply(at)postgresql(dot)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

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Daniel Gustafsson 2020-01-09 09:55:45 Re: Typo in Documentation for Version 12 Section 40.3
Previous Message Daniel Gustafsson 2020-01-09 09:42:10 Re: Suggestion on Document for Version 12 Section 40.3