public inbox for [email protected]
help / color / mirror / Atom feedSuggestion on Document for Version 12 Section 40.3
3+ messages / 3 participants
[nested] [flat]
* Suggestion on Document for Version 12 Section 40.3
@ 2020-01-09 08:28 PG Doc comments form <[email protected]>
2020-01-09 09:42 ` Re: Suggestion on Document for Version 12 Section 40.3 Daniel Gustafsson <[email protected]>
0 siblings, 1 reply; 3+ messages in thread
From: PG Doc comments form @ 2020-01-09 08:28 UTC (permalink / raw)
To: [email protected]; +Cc: [email protected]
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.
Yushan
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Suggestion on Document for Version 12 Section 40.3
2020-01-09 08:28 Suggestion on Document for Version 12 Section 40.3 PG Doc comments form <[email protected]>
@ 2020-01-09 09:42 ` Daniel Gustafsson <[email protected]>
2020-01-09 09:50 ` Re: Suggestion on Document for Version 12 Section 40.3 Magnus Hagander <[email protected]>
0 siblings, 1 reply; 3+ messages in thread
From: Daniel Gustafsson @ 2020-01-09 09:42 UTC (permalink / raw)
To: [email protected]; [email protected]
> On 9 Jan 2020, at 09:28, PG Doc comments form <[email protected]> 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
Attachments:
[application/octet-stream] rules_trgm.diff (579B, 2-rules_trgm.diff)
download | inline diff:
diff --git a/doc/src/sgml/rules.sgml b/doc/src/sgml/rules.sgml
index 2610645663..bcf860b68b 100644
--- a/doc/src/sgml/rules.sgml
+++ b/doc/src/sgml/rules.sgml
@@ -1039,7 +1039,8 @@ SELECT count(*) FROM words WHERE word = 'caterpiler';
</programlisting>
Either way, the word is spelled wrong, so let's look for what we might
- have wanted. Again using <literal>file_fdw</literal>:
+ have wanted. Again using <literal>file_fdw</literal> and
+ <literal>pg_trgm</literal>:
<programlisting>
SELECT word FROM words ORDER BY word <-> 'caterpiler' LIMIT 10;
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Suggestion on Document for Version 12 Section 40.3
2020-01-09 08:28 Suggestion on Document for Version 12 Section 40.3 PG Doc comments form <[email protected]>
2020-01-09 09:42 ` Re: Suggestion on Document for Version 12 Section 40.3 Daniel Gustafsson <[email protected]>
@ 2020-01-09 09:50 ` Magnus Hagander <[email protected]>
0 siblings, 0 replies; 3+ messages in thread
From: Magnus Hagander @ 2020-01-09 09:50 UTC (permalink / raw)
To: Daniel Gustafsson <[email protected]>; +Cc: [email protected]; Pg Docs <[email protected]>
On Thu, Jan 9, 2020 at 10:42 AM Daniel Gustafsson <[email protected]> wrote:
>
> > On 9 Jan 2020, at 09:28, PG Doc comments form <[email protected]> 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
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2020-01-09 09:50 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2020-01-09 08:28 Suggestion on Document for Version 12 Section 40.3 PG Doc comments form <[email protected]>
2020-01-09 09:42 ` Daniel Gustafsson <[email protected]>
2020-01-09 09:50 ` Magnus Hagander <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox