[Doc fix] Wrong explanation about tsquery_phrase

Started by Seki, Eijialmost 9 years ago3 messages

seki.eiji@jp.fujitsu.com

almost 9 years ago

1 attachment(s)

Hi all,

I found a wrong explanation about tsquery_phrase. I was slightly confused when I tried to use it.

The current document explains tsquery_phrase as the followings[1]- https://www.postgresql.org/docs/9.6/static/functions-textsearch.html.

- Function: tsquery_phrase(query1 tsquery, query2 tsquery, distance integer)
- Return Type: tsquery
- Description: make query that searches for query1 followed by query2 at maximum distance distance

However, 'exact distance' seems to be right instead of 'maximum distance'.

This was probably overlooked in the following commit.

028350f619f7688e0453fcd2c4b25abe9ba30fa7

[1]: - https://www.postgresql.org/docs/9.6/static/functions-textsearch.html

--
Regards,
Eiji Seki
Fujitsu

Attachments:

fix_document_about_tsquery_phrase.patchapplication/octet-stream; name=fix_document_about_tsquery_phrase.patchDownload

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 9c53e42..a7c0262 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -9618,7 +9618,7 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
         </entry>
         <entry><type>tsquery</type></entry>
         <entry>make query that searches for <replaceable>query1</> followed by
-         <replaceable>query2</> at maximum distance <replaceable>distance</></entry>
+         <replaceable>query2</> at exact distance <replaceable>distance</></entry>
         <entry><literal>tsquery_phrase(to_tsquery('fat'), to_tsquery('cat'), 10)</literal></entry>
         <entry><literal>'fat' &lt;10&gt; 'cat'</literal></entry>
        </row>

Robert Haas

robertmhaas@gmail.com

almost 9 years ago

In reply to: Seki, Eiji (#1)

Re: [Doc fix] Wrong explanation about tsquery_phrase

On Tue, Feb 28, 2017 at 3:24 PM, Seki, Eiji <seki.eiji@jp.fujitsu.com> wrote:

I found a wrong explanation about tsquery_phrase. I was slightly confused when I tried to use it.

The current document explains tsquery_phrase as the followings[1].

- Function: tsquery_phrase(query1 tsquery, query2 tsquery, distance integer)
- Return Type: tsquery
- Description: make query that searches for query1 followed by query2 at maximum distance distance

However, 'exact distance' seems to be right instead of 'maximum distance'.

This was probably overlooked in the following commit.

028350f619f7688e0453fcd2c4b25abe9ba30fa7

I think you are correct.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

Tom Lane

tgl@sss.pgh.pa.us

almost 9 years ago

In reply to: Seki, Eiji (#1)

Re: [Doc fix] Wrong explanation about tsquery_phrase

"Seki, Eiji" <seki.eiji@jp.fujitsu.com> writes:

I found a wrong explanation about tsquery_phrase. I was slightly confused when I tried to use it.

Yes, this was definitely an oversight in 028350f61; thanks for catching
it! I think though that it would read better if it simply said
"distance", so I changed it that way.

regards, tom lane

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers