diff options
| author | Bruce Momjian | 2023-11-13 21:35:55 +0000 |
|---|---|---|
| committer | Bruce Momjian | 2023-11-13 21:35:55 +0000 |
| commit | 24943fba465b467d9fc70ce1eb82ee255f6992de (patch) | |
| tree | 61f5f3097d9bba78c7ae3621fa52605c8f3ed330 | |
| parent | f279241b09aa3cf4c6162f74dc8b5cc99ebcd196 (diff) | |
doc: clarify handling of ts_headline() operators & extra words
Reported-by: Ngigi Waithaka & Alex Malek
Bug: 15172
Discussion: https://postgr.es/m/[email protected]
Backpatch-through: 16
| -rw-r--r-- | doc/src/sgml/textsearch.sgml | 5 |
1 files changed, 4 insertions, 1 deletions
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 |