From f5b75be030d588a119a19eca336527b7cfa77ec9 Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Mon, 13 Nov 2023 16:35:55 -0500 Subject: [PATCH] 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 1550be5695..a7767049c8 100644 --- a/doc/src/sgml/textsearch.sgml +++ b/doc/src/sgml/textsearch.sgml @@ -1287,7 +1287,10 @@ ts_headline( config ts_headline 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 config; if config is omitted, the