Date: Mon, 30 Oct 2023 09:09:35 -0400
From: Bruce Momjian <bruce@momjian.us>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Alex Malek <magicagent@gmail.com>, pgsql-bugs@lists.postgresql.org,
	ngigi@at.co.ke
Subject: Re: BUG #15172: Postgresql ts_headline with <-> operator does not
 highlight text properly
Message-ID: <ZT-rD8Uhn-RK6pal@momjian.us>
References: <152461454026.19805.6310947081647212894@wrigleys.postgresql.org>
 <CAGH8cccS-9yb1VkgUTAaghz4P3aL8DneH_24bN7Y0LCLO8by1Q@mail.gmail.com>
 <ZT1kGIbiALGclTUA@momjian.us>
 <1995601.1698526000@sss.pgh.pa.us>
 <ZT2akojpqo9rLiV_@momjian.us>
 <2140529.1698594815@sss.pgh.pa.us>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="+PeDBquLR30EP4Zd"
Content-Disposition: inline
In-Reply-To: <2140529.1698594815@sss.pgh.pa.us>
Archived-At: 
 <https://www.postgresql.org/message-id/ZT-rD8Uhn-RK6pal%40momjian.us>
Precedence: bulk


--+PeDBquLR30EP4Zd
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Sun, Oct 29, 2023 at 11:53:35AM -0400, Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > Attached is a proposed doc patch.
> 
> As I pointed out before, the fragments *don't* necessarily satisfy
> the query, so this is still promising too much.
> 
> An important edge case to keep in mind is that the given text
> itself might not satisfy the query; ts_headline has no control
> over what you hand it.  But even if the text as a whole does,
> there may not be small fragments that do.

How is this weasel-wording, attached.  :-)

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

  Only you can decide what is important to you.

--+PeDBquLR30EP4Zd
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="headline.diff"

diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml
index 1550be5695..aa728fa3f8 100644
--- a/doc/src/sgml/textsearch.sgml
+++ b/doc/src/sgml/textsearch.sgml
@@ -1287,7 +1287,10 @@ ts_headline(<optional> <replaceable class="parameter">config</replaceable> <type
    <para>
     <function>ts_headline</function> accepts a document along
     with a query, and returns an excerpt from
-    the document in which terms from the query are highlighted.  The
+    the document in which terms from the query are highlighted.
+    Specifically, the function will use the query to return relevant
+    text fragments, and highlight all words that appear in the query,
+    even if those words do not match the query operator restrictions.  The
     configuration to be used to parse the document can be specified by
     <replaceable>config</replaceable>; if <replaceable>config</replaceable>
     is omitted, the

--+PeDBquLR30EP4Zd--