Re: Suggestion on Document for Version 12 Section 40.3 - Mailing list pgsql-docs

From Daniel Gustafsson
Subject Re: Suggestion on Document for Version 12 Section 40.3
Date
Msg-id 6E6064A4-D57B-4DF0-A0BF-4DFA745ACD47@yesql.se
Whole thread Raw
In response to Suggestion on Document for Version 12 Section 40.3  (PG Doc comments form <noreply@postgresql.org>)
Responses Re: Suggestion on Document for Version 12 Section 40.3
List pgsql-docs
> 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.

cheers ./daniel


Attachment

pgsql-docs by date:

Previous
From: Octopus ZHANG
Date:
Subject: Re: Typo in Documentation for Version 12 Section 40.3
Next
From: Magnus Hagander
Date:
Subject: Re: Suggestion on Document for Version 12 Section 40.3