[Doc fix] Wrong explanation about tsquery_phrase

From: "Seki, Eiji" <seki(dot)eiji(at)jp(dot)fujitsu(dot)com>
To: "pgsql-hackers(at)postgresql(dot)org" <pgsql-hackers(at)postgresql(dot)org>
Subject: [Doc fix] Wrong explanation about tsquery_phrase
Date: 2017-02-28 09:54:17
Message-ID: A11BD0E1A40FAC479D740CEFA373E203396AB26F@g01jpexmbkw05
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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].

- 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

Attachment Content-Type Size
fix_document_about_tsquery_phrase.patch application/octet-stream 746 bytes

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Dmitry Dolgov 2017-02-28 10:59:52 [PATCH] few fts functions for jsonb
Previous Message vinayak 2017-02-28 09:24:57 ANALYZE command progress checker