Skip to content

Commit 6ae7ac6

Browse files
robinstChristoph Büscher
authored and
Christoph Büscher
committed
[Docs] Clarify html encoder in highlighting.asciidoc (#27766)
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
1 parent 04d1489 commit 6ae7ac6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/reference/search/request/highlighting.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,9 @@ You can specify the locale to use with `boundary_scanner_locale`.
139139
boundary_scanner_locale:: Controls which locale is used to search for sentence
140140
and word boundaries.
141141

142-
encoder:: Indicates if the highlighted text should be HTML encoded:
143-
`default` (no encoding) or `html` (escapes HTML highlighting tags).
142+
encoder:: Indicates if the snippet should be HTML encoded:
143+
`default` (no encoding) or `html` (HTML-escape the snippet text and then
144+
insert the highlighting tags)
144145

145146
fields:: Specifies the fields to retrieve highlights for. You can use wildcards
146147
to specify fields. For example, you could specify `comment_*` to

0 commit comments

Comments
 (0)