Skip to content

Commit d6dfa71

Browse files
ESQL: Document MV_SLICE limitations (#114162) (#114348)
`MV_SLICE` is useful, but loading values from lucene frequently sorts them so `MV_SLICE` is not as useful as you think it is. It's mostly for after, say, a `SPLIT`. This documents that and adds a link to the section on multivalues. It also moves similar docs to a separate paragraph in the docs for easier reading. Co-authored-by: Elastic Machine <[email protected]>
1 parent 3558b59 commit d6dfa71

File tree

13 files changed

+44
-26
lines changed

13 files changed

+44
-26
lines changed

docs/reference/esql/functions/description/mv_first.asciidoc

Lines changed: 7 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/description/mv_last.asciidoc

Lines changed: 7 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/description/mv_slice.asciidoc

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/kibana/definition/mv_first.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/kibana/definition/mv_last.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/kibana/definition/mv_slice.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/kibana/docs/mv_first.md

Lines changed: 0 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/kibana/docs/mv_last.md

Lines changed: 0 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/esql/functions/kibana/docs/mv_slice.md

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/FunctionInfo.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,18 @@
2929
boolean preview() default false;
3030

3131
/**
32-
* The description of the function rendered in {@code META FUNCTIONS}
33-
* and the docs. These should be complete sentences.
32+
* The description of the function rendered in the docs and kibana's
33+
* json files that drive their IDE-like experience. These should be
34+
* complete sentences but can contain asciidoc syntax. It is rendered
35+
* as a single paragraph.
3436
*/
3537
String description() default "";
3638

3739
/**
38-
* Detailed descriptions of the function rendered in the docs.
40+
* Detailed descriptions of the function rendered in the docs. This is
41+
* rendered as a single paragraph following {@link #description()} in
42+
* the docs and is <strong>excluded</strong> from Kibana's IDE-like
43+
* experience. It can contain asciidoc syntax.
3944
*/
4045
String detailedDescription() default "";
4146

0 commit comments

Comments
 (0)