Skip to content

Commit 6807bd5

Browse files
nik9000albertzaharovits
authored andcommitted
ESQL: All descriptions are a full sentence (#110791)
This asserts that all functions have descriptions that are complete sentences.
1 parent 79978cd commit 6807bd5

File tree

11 files changed

+20
-12
lines changed

11 files changed

+20
-12
lines changed

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

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/description/substring.asciidoc

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/locate.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/substring.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/locate.md

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/substring.md

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

x-pack/plugin/esql/qa/testFixtures/src/main/resources/meta.csv-spec

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ ip_prefix |Truncates an IP to a given prefix length.
275275
least |Returns the minimum value from multiple columns. This is similar to <<esql-mv_min>> except it is intended to run on multiple columns at once.
276276
left |Returns the substring that extracts 'length' chars from 'string' starting from the left.
277277
length |Returns the character length of a string.
278-
locate |Returns an integer that indicates the position of a keyword substring within another string
278+
locate |Returns an integer that indicates the position of a keyword substring within another string.
279279
log |Returns the logarithm of a value to a base. The input can be any numeric value, the return value is always a double. Logs of zero, negative numbers, and base of one return `null` as well as a warning.
280280
log10 |Returns the logarithm of a value to base 10. The input can be any numeric value, the return value is always a double. Logs of 0 and negative numbers return `null` as well as a warning.
281281
ltrim |Removes leading whitespaces from a string.
@@ -320,7 +320,7 @@ st_within |Returns whether the first geometry is within the second geometry.
320320
st_x |Extracts the `x` coordinate from the supplied point. If the points is of type `geo_point` this is equivalent to extracting the `longitude` value.
321321
st_y |Extracts the `y` coordinate from the supplied point. If the points is of type `geo_point` this is equivalent to extracting the `latitude` value.
322322
starts_with |Returns a boolean that indicates whether a keyword string starts with another string.
323-
substring |Returns a substring of a string, specified by a start position and an optional length
323+
substring |Returns a substring of a string, specified by a start position and an optional length.
324324
sum |The sum of a numeric field.
325325
tan |Returns the {wikipedia}/Sine_and_cosine[Tangent] trigonometric function of an angle.
326326
tanh |Returns the {wikipedia}/Hyperbolic_functions[Tangent] hyperbolic function of an angle.
@@ -351,7 +351,7 @@ to_unsigned_lo|Converts an input value to an unsigned long value. If the input p
351351
to_upper |Returns a new string representing the input string converted to upper case.
352352
to_ver |Converts an input string to a version value.
353353
to_version |Converts an input string to a version value.
354-
top |Collects the top values for a field. Includes repeated values.
354+
top |Collects the top values for a field. Includes repeated values.
355355
trim |Removes leading and trailing whitespaces from a string.
356356
values |Collect values for a field.
357357
weighted_avg |The weighted average of a numeric field.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
/**
2727
* The description of the function rendered in {@code META FUNCTIONS}
28-
* and the docs.
28+
* and the docs. These should be complete sentences.
2929
*/
3030
String description() default "";
3131

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/Locate.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public class Locate extends EsqlScalarFunction implements OptionalArgument {
4848

4949
@FunctionInfo(
5050
returnType = "integer",
51-
description = "Returns an integer that indicates the position of a keyword substring within another string",
51+
description = "Returns an integer that indicates the position of a keyword substring within another string.",
5252
examples = @Example(file = "string", tag = "locate")
5353
)
5454
public Locate(

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/Substring.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public class Substring extends EsqlScalarFunction implements OptionalArgument {
4848

4949
@FunctionInfo(
5050
returnType = "keyword",
51-
description = "Returns a substring of a string, specified by a start position and an optional length",
51+
description = "Returns a substring of a string, specified by a start position and an optional length.",
5252
examples = {
5353
@Example(file = "docs", tag = "substring", description = "This example returns the first three characters of every last name:"),
5454
@Example(file = "docs", tag = "substringEnd", description = """

0 commit comments

Comments
 (0)