Browse Source

[ESQL] Add in the autogenerated docs for a bunch of functions (#107633)

Mark Tozzi 1 year ago
parent
commit
f620961812
26 changed files with 141 additions and 20 deletions
  1. 1 1
      docs/reference/esql/functions/description/pi.asciidoc
  2. 1 1
      docs/reference/esql/functions/description/round.asciidoc
  3. 1 1
      docs/reference/esql/functions/kibana/definition/pi.json
  4. 1 1
      docs/reference/esql/functions/kibana/definition/round.json
  5. 1 1
      docs/reference/esql/functions/kibana/docs/acos.md
  6. 1 1
      docs/reference/esql/functions/kibana/docs/asin.md
  7. 1 1
      docs/reference/esql/functions/kibana/docs/atan.md
  8. 1 1
      docs/reference/esql/functions/kibana/docs/atan2.md
  9. 1 1
      docs/reference/esql/functions/kibana/docs/ceil.md
  10. 1 1
      docs/reference/esql/functions/kibana/docs/cos.md
  11. 1 1
      docs/reference/esql/functions/kibana/docs/cosh.md
  12. 1 1
      docs/reference/esql/functions/kibana/docs/floor.md
  13. 1 1
      docs/reference/esql/functions/kibana/docs/pi.md
  14. 4 3
      docs/reference/esql/functions/kibana/docs/round.md
  15. 1 1
      docs/reference/esql/functions/kibana/docs/sin.md
  16. 1 1
      docs/reference/esql/functions/kibana/docs/sinh.md
  17. 1 1
      docs/reference/esql/functions/kibana/docs/tan.md
  18. 1 1
      docs/reference/esql/functions/kibana/docs/tanh.md
  19. 7 0
      docs/reference/esql/functions/types/div.asciidoc
  20. 21 0
      docs/reference/esql/functions/types/equals.asciidoc
  21. 16 0
      docs/reference/esql/functions/types/greater_than.asciidoc
  22. 16 0
      docs/reference/esql/functions/types/greater_than_or_equal.asciidoc
  23. 16 0
      docs/reference/esql/functions/types/less_than.asciidoc
  24. 16 0
      docs/reference/esql/functions/types/less_than_or_equal.asciidoc
  25. 7 0
      docs/reference/esql/functions/types/mod.asciidoc
  26. 21 0
      docs/reference/esql/functions/types/not_equals.asciidoc

+ 1 - 1
docs/reference/esql/functions/description/pi.asciidoc

@@ -2,4 +2,4 @@
 
 *Description*
 
-Returns the {wikipedia}/Pi[ratio] of a circle's circumference to its diameter.
+Returns {wikipedia}/Pi[Pi], the ratio of a circle's circumference to its diameter.

+ 1 - 1
docs/reference/esql/functions/description/round.asciidoc

@@ -2,4 +2,4 @@
 
 *Description*
 
-Rounds a number to the closest number with the specified number of digits. Defaults to 0 digits if no number of digits is provided. If the specified number of digits is negative, rounds to the number of digits left of the decimal point.
+Rounds a number to the specified number of decimal places. Defaults to 0, which returns the nearest integer. If the precision is a negative number, rounds to the number of digits left of the decimal point.

+ 1 - 1
docs/reference/esql/functions/kibana/definition/pi.json

@@ -2,7 +2,7 @@
   "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.",
   "type" : "eval",
   "name" : "pi",
-  "description" : "Returns the ratio of a circle's circumference to its diameter.",
+  "description" : "Returns Pi, the ratio of a circle's circumference to its diameter.",
   "signatures" : [
     {
       "params" : [ ],

+ 1 - 1
docs/reference/esql/functions/kibana/definition/round.json

@@ -2,7 +2,7 @@
   "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.",
   "type" : "eval",
   "name" : "round",
-  "description" : "Rounds a number to the closest number with the specified number of digits.\nDefaults to 0 digits if no number of digits is provided. If the specified number\nof digits is negative, rounds to the number of digits left of the decimal point.",
+  "description" : "Rounds a number to the specified number of decimal places.\nDefaults to 0, which returns the nearest integer. If the\nprecision is a negative number, rounds to the number of digits left\nof the decimal point.",
   "signatures" : [
     {
       "params" : [

+ 1 - 1
docs/reference/esql/functions/kibana/docs/acos.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### ACOS
-Returns the {wikipedia}/Inverse_trigonometric_functions[arccosine] of `n` as an angle, expressed in radians.
+Returns the arccosine of `n` as an angle, expressed in radians.
 
 ```
 ROW a=.9

+ 1 - 1
docs/reference/esql/functions/kibana/docs/asin.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### ASIN
-Returns the {wikipedia}/Inverse_trigonometric_functions[arcsine] of the input
+Returns the arcsine of the input
 numeric expression as an angle, expressed in radians.
 
 ```

+ 1 - 1
docs/reference/esql/functions/kibana/docs/atan.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### ATAN
-Returns the {wikipedia}/Inverse_trigonometric_functions[arctangent] of the input
+Returns the arctangent of the input
 numeric expression as an angle, expressed in radians.
 
 ```

+ 1 - 1
docs/reference/esql/functions/kibana/docs/atan2.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### ATAN2
-The {wikipedia}/Atan2[angle] between the positive x-axis and the ray from the
+The angle between the positive x-axis and the ray from the
 origin to the point (x , y) in the Cartesian plane, expressed in radians.
 
 ```

+ 1 - 1
docs/reference/esql/functions/kibana/docs/ceil.md

@@ -9,4 +9,4 @@ Round a number up to the nearest integer.
 ROW a=1.8
 | EVAL a=CEIL(a)
 ```
-Note: This is a noop for `long` (including unsigned) and `integer`. For `double` this picks the closest `double` value to the integer similar to {javadoc}/java.base/java/lang/Math.html#ceil(double)[Math.ceil].
+Note: This is a noop for `long` (including unsigned) and `integer`. For `double` this picks the closest `double` value to the integer similar to Math.ceil.

+ 1 - 1
docs/reference/esql/functions/kibana/docs/cos.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### COS
-Returns the {wikipedia}/Sine_and_cosine[cosine] of an angle.
+Returns the cosine of an angle.
 
 ```
 ROW a=1.8 

+ 1 - 1
docs/reference/esql/functions/kibana/docs/cosh.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### COSH
-Returns the {wikipedia}/Hyperbolic_functions[hyperbolic cosine] of an angle.
+Returns the hyperbolic cosine of an angle.
 
 ```
 ROW a=1.8 

+ 1 - 1
docs/reference/esql/functions/kibana/docs/floor.md

@@ -11,4 +11,4 @@ ROW a=1.8
 ```
 Note: This is a noop for `long` (including unsigned) and `integer`.
 For `double` this picks the closest `double` value to the integer
-similar to {javadoc}/java.base/java/lang/Math.html#floor(double)[Math.floor].
+similar to Math.floor.

+ 1 - 1
docs/reference/esql/functions/kibana/docs/pi.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### PI
-Returns the {wikipedia}/Pi[ratio] of a circle's circumference to its diameter.
+Returns Pi, the ratio of a circle's circumference to its diameter.
 
 ```
 ROW PI()

+ 4 - 3
docs/reference/esql/functions/kibana/docs/round.md

@@ -3,9 +3,10 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### ROUND
-Rounds a number to the closest number with the specified number of digits.
-Defaults to 0 digits if no number of digits is provided. If the specified number
-of digits is negative, rounds to the number of digits left of the decimal point.
+Rounds a number to the specified number of decimal places.
+Defaults to 0, which returns the nearest integer. If the
+precision is a negative number, rounds to the number of digits left
+of the decimal point.
 
 ```
 FROM employees

+ 1 - 1
docs/reference/esql/functions/kibana/docs/sin.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### SIN
-Returns ths {wikipedia}/Sine_and_cosine[Sine] trigonometric function of an angle.
+Returns ths Sine trigonometric function of an angle.
 
 ```
 ROW a=1.8 

+ 1 - 1
docs/reference/esql/functions/kibana/docs/sinh.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### SINH
-Returns the {wikipedia}/Hyperbolic_functions[hyperbolic sine] of an angle.
+Returns the hyperbolic sine of an angle.
 
 ```
 ROW a=1.8 

+ 1 - 1
docs/reference/esql/functions/kibana/docs/tan.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### TAN
-Returns the {wikipedia}/Sine_and_cosine[Tangent] trigonometric function of an angle.
+Returns the Tangent trigonometric function of an angle.
 
 ```
 ROW a=1.8 

+ 1 - 1
docs/reference/esql/functions/kibana/docs/tanh.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### TANH
-Returns the {wikipedia}/Hyperbolic_functions[Tangent] hyperbolic function of an angle.
+Returns the Tangent hyperbolic function of an angle.
 
 ```
 ROW a=1.8 

+ 7 - 0
docs/reference/esql/functions/types/div.asciidoc

@@ -6,6 +6,13 @@
 |===
 lhs | rhs | result
 double | double | double
+double | integer | double
+double | long | double
+integer | double | double
 integer | integer | integer
+integer | long | long
+long | double | double
+long | integer | long
 long | long | long
+unsigned_long | unsigned_long | unsigned_long
 |===

+ 21 - 0
docs/reference/esql/functions/types/equals.asciidoc

@@ -5,5 +5,26 @@
 [%header.monospaced.styled,format=dsv,separator=|]
 |===
 lhs | rhs | result
+boolean | boolean | boolean
+cartesian_point | cartesian_point | boolean
+cartesian_shape | cartesian_shape | boolean
+datetime | datetime | boolean
+double | double | boolean
+double | integer | boolean
+double | long | boolean
+geo_point | geo_point | boolean
+geo_shape | geo_shape | boolean
+integer | double | boolean
 integer | integer | boolean
+integer | long | boolean
+ip | ip | boolean
+keyword | keyword | boolean
+keyword | text | boolean
+long | double | boolean
+long | integer | boolean
+long | long | boolean
+text | keyword | boolean
+text | text | boolean
+unsigned_long | unsigned_long | boolean
+version | version | boolean
 |===

+ 16 - 0
docs/reference/esql/functions/types/greater_than.asciidoc

@@ -5,5 +5,21 @@
 [%header.monospaced.styled,format=dsv,separator=|]
 |===
 lhs | rhs | result
+datetime | datetime | boolean
+double | double | boolean
+double | integer | boolean
+double | long | boolean
+integer | double | boolean
 integer | integer | boolean
+integer | long | boolean
+ip | ip | boolean
+keyword | keyword | boolean
+keyword | text | boolean
+long | double | boolean
+long | integer | boolean
+long | long | boolean
+text | keyword | boolean
+text | text | boolean
+unsigned_long | unsigned_long | boolean
+version | version | boolean
 |===

+ 16 - 0
docs/reference/esql/functions/types/greater_than_or_equal.asciidoc

@@ -5,5 +5,21 @@
 [%header.monospaced.styled,format=dsv,separator=|]
 |===
 lhs | rhs | result
+datetime | datetime | boolean
+double | double | boolean
+double | integer | boolean
+double | long | boolean
+integer | double | boolean
 integer | integer | boolean
+integer | long | boolean
+ip | ip | boolean
+keyword | keyword | boolean
+keyword | text | boolean
+long | double | boolean
+long | integer | boolean
+long | long | boolean
+text | keyword | boolean
+text | text | boolean
+unsigned_long | unsigned_long | boolean
+version | version | boolean
 |===

+ 16 - 0
docs/reference/esql/functions/types/less_than.asciidoc

@@ -5,5 +5,21 @@
 [%header.monospaced.styled,format=dsv,separator=|]
 |===
 lhs | rhs | result
+datetime | datetime | boolean
+double | double | boolean
+double | integer | boolean
+double | long | boolean
+integer | double | boolean
 integer | integer | boolean
+integer | long | boolean
+ip | ip | boolean
+keyword | keyword | boolean
+keyword | text | boolean
+long | double | boolean
+long | integer | boolean
+long | long | boolean
+text | keyword | boolean
+text | text | boolean
+unsigned_long | unsigned_long | boolean
+version | version | boolean
 |===

+ 16 - 0
docs/reference/esql/functions/types/less_than_or_equal.asciidoc

@@ -5,5 +5,21 @@
 [%header.monospaced.styled,format=dsv,separator=|]
 |===
 lhs | rhs | result
+datetime | datetime | boolean
+double | double | boolean
+double | integer | boolean
+double | long | boolean
+integer | double | boolean
 integer | integer | boolean
+integer | long | boolean
+ip | ip | boolean
+keyword | keyword | boolean
+keyword | text | boolean
+long | double | boolean
+long | integer | boolean
+long | long | boolean
+text | keyword | boolean
+text | text | boolean
+unsigned_long | unsigned_long | boolean
+version | version | boolean
 |===

+ 7 - 0
docs/reference/esql/functions/types/mod.asciidoc

@@ -6,6 +6,13 @@
 |===
 lhs | rhs | result
 double | double | double
+double | integer | double
+double | long | double
+integer | double | double
 integer | integer | integer
+integer | long | long
+long | double | double
+long | integer | long
 long | long | long
+unsigned_long | unsigned_long | unsigned_long
 |===

+ 21 - 0
docs/reference/esql/functions/types/not_equals.asciidoc

@@ -5,5 +5,26 @@
 [%header.monospaced.styled,format=dsv,separator=|]
 |===
 lhs | rhs | result
+boolean | boolean | boolean
+cartesian_point | cartesian_point | boolean
+cartesian_shape | cartesian_shape | boolean
+datetime | datetime | boolean
+double | double | boolean
+double | integer | boolean
+double | long | boolean
+geo_point | geo_point | boolean
+geo_shape | geo_shape | boolean
+integer | double | boolean
 integer | integer | boolean
+integer | long | boolean
+ip | ip | boolean
+keyword | keyword | boolean
+keyword | text | boolean
+long | double | boolean
+long | integer | boolean
+long | long | boolean
+text | keyword | boolean
+text | text | boolean
+unsigned_long | unsigned_long | boolean
+version | version | boolean
 |===