Skip to content

Commit 24943fb

Browse files
committed
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
1 parent f279241 commit 24943fb

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/src/sgml/textsearch.sgml

+4-1
Original file line numberDiff line numberDiff line change
@@ -1287,7 +1287,10 @@ ts_headline(<optional> <replaceable class="parameter">config</replaceable> <type
12871287
<para>
12881288
<function>ts_headline</function> accepts a document along
12891289
with a query, and returns an excerpt from
1290-
the document in which terms from the query are highlighted. The
1290+
the document in which terms from the query are highlighted.
1291+
Specifically, the function will use the query to select relevant
1292+
text fragments, and then highlight all words that appear in the query,
1293+
even if those word positions do not match the query's restrictions. The
12911294
configuration to be used to parse the document can be specified by
12921295
<replaceable>config</replaceable>; if <replaceable>config</replaceable>
12931296
is omitted, the

0 commit comments

Comments
 (0)