docs: Clarify html encoder #27766
docs: Clarify html encoder #27766
Conversation
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
|
Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually? |
cbuescher
added
>docs
There was a problem hiding this comment.
@robinst sorry for the long silence on this, it seems this PR somehow fell through the cracks. I just checked the encoder behaviour and also think the current description is misleading. I left two small comment how I think the PR could be changed, let me know if you agree and want to adjust this slightly.
| @@ -137,7 +137,7 @@ boundary_scanner_locale:: Controls which locale is used to search for sentence | |||
| and word boundaries. | |||
|
|
|||
| encoder:: Indicates if the highlighted text should be HTML encoded: | |||
There was a problem hiding this comment.
I just checked that for "html" not only text between highlight tags gets escaped, but the whole snippet. I think you could also change "text" here to "text snippet" or just "snippet". Would that make more sense?
There was a problem hiding this comment.
Yeah it's a bit confusing because "highlighted text" could also refer to all the text that is being highlighted (as opposed to the text between the highlighting tags).
|
Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually? |
|
@cbuescher: I've included your suggestion and reworded it a bit more. |
|
@elasticmachine test this please |
|
Unfortunately the branch is a bit old, so CI fails because we now use the gradle wrapper. However, I checked the docs build manually and since this doesn't change code or involves any code snippet tests I will merge it to avoid having to go through a full rebase & test cycle. |
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
|
@robinst thanks again and sorry for the wait. I merged this to master and all the 6.x branches, will be online like this soon. |
* es/master: [Docs] Fix explanation for `from` and `size` example (#28320) Adapt bwc version after backport #28358 Always return the after_key in composite aggregation response (#28358) Adds test name to MockPageCacheRecycler exception (#28359) Adds a note in the `terms` aggregation docs regarding pagination (#28360) [Test] Fix DiscoveryNodesTests.testDeltas() (#28361) Update packaging tests to work with meta plugins (#28336) Remove Painless Type from MethodWriter in favor of Java Class. (#28346) [Doc] Fixs typo in reverse-nested-aggregation.asciidoc (#28348) Reindex: Shore up rethrottle test Only assert single commit iff index created on 6.2 isHeldByCurrentThread should return primitive bool [Docs] Clarify `html` encoder in highlighting.asciidoc (#27766) Fix GeoDistance query example (#28355) Settings: Introduce settings updater for a list of settings (#28338) Adapt bwc version after backport #28310
* es/6.x: [Docs] Fix explanation for `from` and `size` example (#28320) Adapt bwc version after backport #28358 Always return the after_key in composite aggregation response (#28358) Adds a note in the `terms` aggregation docs regarding pagination (#28360) Update packaging tests to work with meta plugins (#28336) Remove Painless Type from MethodWriter in favor of Java Class. (#28346) [Doc] Fixs typo in reverse-nested-aggregation.asciidoc (#28348) [Docs] Fixed Indices information breaking changes (#27914) Reindex: Shore up rethrottle test isHeldByCurrentThread should return primitive bool [Docs] Clarify `html` encoder in highlighting.asciidoc (#27766) Only assert single commit iff index created on 6.2 Deprecate the `update_all_types` option. (#28284) Fix GeoDistance query example Settings: Introduce settings updater for a list of settings (#28338) [Docs] Fix asciidoc style in composite agg docs Adapt bwc version after backport #28310 Adds the ability to specify a format on composite date_histogram source (#28310)
* master: (23 commits) Update Netty to 4.1.16.Final (elastic#28345) Fix peer recovery flushing loop (elastic#28350) REST high-level client: add support for exists alias (elastic#28332) REST high-level client: move to POST when calling API to retrieve which support request body (elastic#28342) Add Indices Aliases API to the high level REST client (elastic#27876) Java Api clean up: remove deprecated `isShardsAcked` (elastic#28311) [Docs] Fix explanation for `from` and `size` example (elastic#28320) Adapt bwc version after backport elastic#28358 Always return the after_key in composite aggregation response (elastic#28358) Adds test name to MockPageCacheRecycler exception (elastic#28359) Adds a note in the `terms` aggregation docs regarding pagination (elastic#28360) [Test] Fix DiscoveryNodesTests.testDeltas() (elastic#28361) Update packaging tests to work with meta plugins (elastic#28336) Remove Painless Type from MethodWriter in favor of Java Class. (elastic#28346) [Doc] Fixs typo in reverse-nested-aggregation.asciidoc (elastic#28348) Reindex: Shore up rethrottle test Only assert single commit iff index created on 6.2 isHeldByCurrentThread should return primitive bool [Docs] Clarify `html` encoder in highlighting.asciidoc (elastic#27766) Fix GeoDistance query example (elastic#28355) ...
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.