postgres.git / summary / log / commit / refs

commit    f5b75be030d588a119a19eca336527b7cfa77ec9
Author:   Bruce Momjian <bruce@momjian.us>
Date:     Mon Nov 13 21:35:55 2023 +0000
First released in: 17.0, 16.2

    doc:  clarify handling of ts_headline() operators & extra words
    
    Reported-by: Ngigi Waithaka & Alex Malek
    
    Bug: 15172
    
    Discussion: https://postgr.es/m/152461454026.19805.6310947081647212894@wrigleys.postgresql.org
    
    Backpatch-through: 16


 doc/src/sgml/textsearch.sgml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml
index 1550be56950..a7767049c8c 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 select relevant
+    text fragments, and then highlight all words that appear in the query,
+    even if those word positions do not match the query's restrictions.  The
     configuration to be used to parse the document can be specified by
     <replaceable>config</replaceable>; if <replaceable>config</replaceable>
     is omitted, the


[parent: 17d490ef32cc]