Clarify which operators are generated and which are static

craigtaverner · craigtaverner · commit 083a478b52a4 · 2025-03-19T11:14:32.000+01:00
diff --git a/docs/reference/query-languages/esql/_snippets/operators/detailedDescription/like.md b/docs/reference/query-languages/esql/_snippets/operators/detailedDescription/like.md
@@ -1,3 +1,4 @@
+% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
 
 Matching the exact characters `*` and `.` will require escaping.
 The escape character is backslash `\`. Since also backslash is a special character in string literals,
diff --git a/docs/reference/query-languages/esql/_snippets/operators/detailedDescription/rlike.md b/docs/reference/query-languages/esql/_snippets/operators/detailedDescription/rlike.md
@@ -1,3 +1,4 @@
+% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
 
 Matching special characters (eg. `.`, `*`, `(`...) will require escaping.
 The escape character is backslash `\`. Since also backslash is a special character in string literals,
diff --git a/docs/reference/query-languages/esql/_snippets/operators/examples/cast.md b/docs/reference/query-languages/esql/_snippets/operators/examples/cast.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 **Example**
 
 ```esql
diff --git a/docs/reference/query-languages/esql/_snippets/operators/examples/predicates.md b/docs/reference/query-languages/esql/_snippets/operators/examples/predicates.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 **Examples**
 
 ```esql
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/add.md b/docs/reference/query-languages/esql/_snippets/operators/layout/add.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Add `+` [esql-add]
 
 :::{image} ../../../images/operators/add.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/cast.md b/docs/reference/query-languages/esql/_snippets/operators/layout/cast.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## `Cast (::)` [esql-cast-operator]
 
 The `::` operator provides a convenient alternative syntax to the TO_<type> [conversion functions](../../../esql-functions-operators.md#esql-type-conversion-functions).
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/div.md b/docs/reference/query-languages/esql/_snippets/operators/layout/div.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Divide `/` [esql-div]
 
 :::{image} ../../../images/operators/div.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/equals.md b/docs/reference/query-languages/esql/_snippets/operators/layout/equals.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Equality [esql-equals]
 
 **Syntax**
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/greater_than.md b/docs/reference/query-languages/esql/_snippets/operators/layout/greater_than.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Greater than `>` [esql-greater_than]
 
 :::{image} ../../../images/operators/greater_than.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/greater_than_or_equal.md b/docs/reference/query-languages/esql/_snippets/operators/layout/greater_than_or_equal.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Greater than or equal to `>=` [esql-greater_than_or_equal]
 
 :::{image} ../../../images/operators/greater_than_or_equal.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/in.md b/docs/reference/query-languages/esql/_snippets/operators/layout/in.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## `IN` [esql-in-operator]
 
 The `IN` operator allows testing whether a field or expression equals an element in a list of literals, fields or expressions.
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/less_than.md b/docs/reference/query-languages/esql/_snippets/operators/layout/less_than.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Less than `<` [esql-less_than]
 
 :::{image} ../../../images/operators/less_than.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/less_than_or_equal.md b/docs/reference/query-languages/esql/_snippets/operators/layout/less_than_or_equal.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Less than or equal to `<=` [esql-less_than_or_equal]
 
 :::{image} ../../../images/operators/less_than_or_equal.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/like.md b/docs/reference/query-languages/esql/_snippets/operators/layout/like.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## `LIKE` [esql-like]
 
 Use `LIKE` to filter data based on string patterns using wildcards. `LIKE` usually acts on a field placed on the left-hand side of the operator, but it can also act on a constant (literal) expression. The right-hand side of the operator represents the pattern.
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/match_operator.md b/docs/reference/query-languages/esql/_snippets/operators/layout/match_operator.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 The only search operator is match (`:`).
 
 **Syntax**
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/mod.md b/docs/reference/query-languages/esql/_snippets/operators/layout/mod.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Modulus `%` [esql-mod]
 
 :::{image} ../../../images/operators/mod.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/mul.md b/docs/reference/query-languages/esql/_snippets/operators/layout/mul.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Multiply `*` [esql-mul]
 
 :::{image} ../../../images/operators/mul.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/neg.md b/docs/reference/query-languages/esql/_snippets/operators/layout/neg.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 The only unary operator is negation (`-`):
 
 **Syntax**
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/not_equals.md b/docs/reference/query-languages/esql/_snippets/operators/layout/not_equals.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Inequality `!=` [esql-not_equals]
 
 :::{image} ../../../images/operators/not_equals.svg
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/predicates.md b/docs/reference/query-languages/esql/_snippets/operators/layout/predicates.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## `IS NULL` and `IS NOT NULL` predicates [esql-predicates]
 
 For NULL comparison, use the `IS NULL` and `IS NOT NULL` predicates.
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/rlike.md b/docs/reference/query-languages/esql/_snippets/operators/layout/rlike.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## `RLIKE` [esql-rlike]
 
 Use `RLIKE` to filter data based on string patterns using using [regular expressions](/reference/query-languages/query-dsl/regexp-syntax.md). `RLIKE` usually acts on a field placed on the left-hand side of the operator, but it can also act on a constant (literal) expression. The right-hand side of the operator represents the pattern.
diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/sub.md b/docs/reference/query-languages/esql/_snippets/operators/layout/sub.md
@@ -1,5 +1,3 @@
-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-
 ## Subtract `-` [esql-sub]
 
 :::{image} ../../../images/operators/sub.svg
diff --git a/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java b/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java
@@ -627,7 +627,7 @@ void renderDetailedDescription(String detailedDescription, String note) throws I
             StringBuilder rendered = new StringBuilder();
             if (Strings.isNullOrEmpty(detailedDescription) == false) {
                 detailedDescription = replaceLinks(detailedDescription.trim());
-                rendered.append("\n").append(detailedDescription).append("\n");
+                rendered.append(DOCS_WARNING).append(detailedDescription).append("\n");
             }
 
             if (Strings.isNullOrEmpty(note) == false) {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`1`	`2`
`2`	`3`	Matching the exact characters `*` and `.` will require escaping.
`3`	`4`	The escape character is backslash `\`. Since also backslash is a special character in string literals,
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`1`	`2`
`2`	`3`	Matching special characters (eg. `.`, `*`, `(`...) will require escaping.
`3`	`4`	The escape character is backslash `\`. Since also backslash is a special character in string literals,
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	`Example`
`4`	`2`
`5`	`3`	```esql
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	`Examples`
`4`	`2`
`5`	`3`	```esql
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	## Add `+` [esql-add]
`4`	`2`
`5`	`3`	`:::{image} ../../../images/operators/add.svg`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	## `Cast (::)` [esql-cast-operator]
`4`	`2`
`5`	`3`	The `::` operator provides a convenient alternative syntax to the TO_<type> [conversion functions](../../../esql-functions-operators.md#esql-type-conversion-functions).
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	## Divide `/` [esql-div]
`4`	`2`
`5`	`3`	`:::{image} ../../../images/operators/div.svg`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	`## Equality [esql-equals]`
`4`	`2`
`5`	`3`	`Syntax`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	## Greater than `>` [esql-greater_than]
`4`	`2`
`5`	`3`	`:::{image} ../../../images/operators/greater_than.svg`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.`
`2`		`-`
`3`	`1`	## Greater than or equal to `>=` [esql-greater_than_or_equal]
`4`	`2`
`5`	`3`	`:::{image} ../../../images/operators/greater_than_or_equal.svg`