From cf982409503758b3d842c963ad8e5987ab2f909c Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Mon, 9 Sep 2024 11:28:31 -0400 Subject: [PATCH] Update docs from code --- .../esql/functions/description/cosh.asciidoc | 2 +- .../esql/functions/description/sin.asciidoc | 2 +- .../esql/functions/description/sinh.asciidoc | 2 +- .../esql/functions/description/tan.asciidoc | 2 +- .../esql/functions/description/tanh.asciidoc | 2 +- .../esql/functions/kibana/definition/cosh.json | 18 +++++++++--------- .../esql/functions/kibana/definition/sin.json | 2 +- .../esql/functions/kibana/definition/sinh.json | 18 +++++++++--------- .../esql/functions/kibana/definition/tan.json | 2 +- .../esql/functions/kibana/definition/tanh.json | 18 +++++++++--------- .../esql/functions/kibana/docs/cosh.md | 2 +- .../esql/functions/kibana/docs/sin.md | 2 +- .../esql/functions/kibana/docs/sinh.md | 2 +- .../esql/functions/kibana/docs/tan.md | 2 +- .../esql/functions/kibana/docs/tanh.md | 2 +- .../esql/functions/parameters/cosh.asciidoc | 4 ++-- .../esql/functions/parameters/sinh.asciidoc | 4 ++-- .../esql/functions/parameters/tanh.asciidoc | 4 ++-- .../esql/functions/signature/cosh.svg | 2 +- .../esql/functions/signature/sinh.svg | 2 +- .../esql/functions/signature/tanh.svg | 2 +- .../esql/functions/types/cosh.asciidoc | 2 +- .../esql/functions/types/sinh.asciidoc | 2 +- .../esql/functions/types/tanh.asciidoc | 2 +- 24 files changed, 51 insertions(+), 51 deletions(-) diff --git a/docs/reference/esql/functions/description/cosh.asciidoc b/docs/reference/esql/functions/description/cosh.asciidoc index bfe51f9152875..ddace7da54343 100644 --- a/docs/reference/esql/functions/description/cosh.asciidoc +++ b/docs/reference/esql/functions/description/cosh.asciidoc @@ -2,4 +2,4 @@ *Description* -Returns the {wikipedia}/Hyperbolic_functions[hyperbolic cosine] of an angle. +Returns the {wikipedia}/Hyperbolic_functions[hyperbolic cosine] of a number. diff --git a/docs/reference/esql/functions/description/sin.asciidoc b/docs/reference/esql/functions/description/sin.asciidoc index ba12ba88ca37a..40f5a46d1863d 100644 --- a/docs/reference/esql/functions/description/sin.asciidoc +++ b/docs/reference/esql/functions/description/sin.asciidoc @@ -2,4 +2,4 @@ *Description* -Returns ths {wikipedia}/Sine_and_cosine[Sine] trigonometric function of an angle. +Returns the {wikipedia}/Sine_and_cosine[sine] of an angle. diff --git a/docs/reference/esql/functions/description/sinh.asciidoc b/docs/reference/esql/functions/description/sinh.asciidoc index bb7761e2a0254..be7aee68f5932 100644 --- a/docs/reference/esql/functions/description/sinh.asciidoc +++ b/docs/reference/esql/functions/description/sinh.asciidoc @@ -2,4 +2,4 @@ *Description* -Returns the {wikipedia}/Hyperbolic_functions[hyperbolic sine] of an angle. +Returns the {wikipedia}/Hyperbolic_functions[hyperbolic sine] of a number. diff --git a/docs/reference/esql/functions/description/tan.asciidoc b/docs/reference/esql/functions/description/tan.asciidoc index 925bebf044a7b..dae37126f0ad3 100644 --- a/docs/reference/esql/functions/description/tan.asciidoc +++ b/docs/reference/esql/functions/description/tan.asciidoc @@ -2,4 +2,4 @@ *Description* -Returns the {wikipedia}/Sine_and_cosine[Tangent] trigonometric function of an angle. +Returns the {wikipedia}/Sine_and_cosine[tangent] of an angle. diff --git a/docs/reference/esql/functions/description/tanh.asciidoc b/docs/reference/esql/functions/description/tanh.asciidoc index 7ee5e457dfe48..42c73a7536dc3 100644 --- a/docs/reference/esql/functions/description/tanh.asciidoc +++ b/docs/reference/esql/functions/description/tanh.asciidoc @@ -2,4 +2,4 @@ *Description* -Returns the {wikipedia}/Hyperbolic_functions[Tangent] hyperbolic function of an angle. +Returns the {wikipedia}/Hyperbolic_functions[hyperbolic tangent] of a number. diff --git a/docs/reference/esql/functions/kibana/definition/cosh.json b/docs/reference/esql/functions/kibana/definition/cosh.json index a34eee15be37e..dca261d971c40 100644 --- a/docs/reference/esql/functions/kibana/definition/cosh.json +++ b/docs/reference/esql/functions/kibana/definition/cosh.json @@ -2,15 +2,15 @@ "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.", "type" : "eval", "name" : "cosh", - "description" : "Returns the hyperbolic cosine of an angle.", + "description" : "Returns the hyperbolic cosine of a number.", "signatures" : [ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "double", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -19,10 +19,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "integer", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -31,10 +31,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "long", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -43,10 +43,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "unsigned_long", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, diff --git a/docs/reference/esql/functions/kibana/definition/sin.json b/docs/reference/esql/functions/kibana/definition/sin.json index 8d092bd0c15a3..ce46fa66a2acc 100644 --- a/docs/reference/esql/functions/kibana/definition/sin.json +++ b/docs/reference/esql/functions/kibana/definition/sin.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" : "sin", - "description" : "Returns ths Sine trigonometric function of an angle.", + "description" : "Returns the sine of an angle.", "signatures" : [ { "params" : [ diff --git a/docs/reference/esql/functions/kibana/definition/sinh.json b/docs/reference/esql/functions/kibana/definition/sinh.json index 2261b18134f6c..e773e95e5e9e1 100644 --- a/docs/reference/esql/functions/kibana/definition/sinh.json +++ b/docs/reference/esql/functions/kibana/definition/sinh.json @@ -2,15 +2,15 @@ "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.", "type" : "eval", "name" : "sinh", - "description" : "Returns the hyperbolic sine of an angle.", + "description" : "Returns the hyperbolic sine of a number.", "signatures" : [ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "double", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -19,10 +19,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "integer", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -31,10 +31,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "long", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -43,10 +43,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "unsigned_long", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, diff --git a/docs/reference/esql/functions/kibana/definition/tan.json b/docs/reference/esql/functions/kibana/definition/tan.json index 7498964dc1a2c..f5452f310a995 100644 --- a/docs/reference/esql/functions/kibana/definition/tan.json +++ b/docs/reference/esql/functions/kibana/definition/tan.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" : "tan", - "description" : "Returns the Tangent trigonometric function of an angle.", + "description" : "Returns the tangent of an angle.", "signatures" : [ { "params" : [ diff --git a/docs/reference/esql/functions/kibana/definition/tanh.json b/docs/reference/esql/functions/kibana/definition/tanh.json index 507f62d394be3..081d606b64217 100644 --- a/docs/reference/esql/functions/kibana/definition/tanh.json +++ b/docs/reference/esql/functions/kibana/definition/tanh.json @@ -2,15 +2,15 @@ "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.", "type" : "eval", "name" : "tanh", - "description" : "Returns the Tangent hyperbolic function of an angle.", + "description" : "Returns the hyperbolic tangent of a number.", "signatures" : [ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "double", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -19,10 +19,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "integer", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -31,10 +31,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "long", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, @@ -43,10 +43,10 @@ { "params" : [ { - "name" : "angle", + "name" : "number", "type" : "unsigned_long", "optional" : false, - "description" : "An angle, in radians. If `null`, the function returns `null`." + "description" : "Numeric expression. If `null`, the function returns `null`." } ], "variadic" : false, diff --git a/docs/reference/esql/functions/kibana/docs/cosh.md b/docs/reference/esql/functions/kibana/docs/cosh.md index d5cc126650e44..0338429521781 100644 --- a/docs/reference/esql/functions/kibana/docs/cosh.md +++ b/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 hyperbolic cosine of an angle. +Returns the hyperbolic cosine of a number. ``` ROW a=1.8 diff --git a/docs/reference/esql/functions/kibana/docs/sin.md b/docs/reference/esql/functions/kibana/docs/sin.md index 1e1fc5ee9c938..d1128350d12fb 100644 --- a/docs/reference/esql/functions/kibana/docs/sin.md +++ b/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 Sine trigonometric function of an angle. +Returns the sine of an angle. ``` ROW a=1.8 diff --git a/docs/reference/esql/functions/kibana/docs/sinh.md b/docs/reference/esql/functions/kibana/docs/sinh.md index 886b3b95b09f8..249c9bb0906c3 100644 --- a/docs/reference/esql/functions/kibana/docs/sinh.md +++ b/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 hyperbolic sine of an angle. +Returns the hyperbolic sine of a number. ``` ROW a=1.8 diff --git a/docs/reference/esql/functions/kibana/docs/tan.md b/docs/reference/esql/functions/kibana/docs/tan.md index f1594f4de7476..41bd3c814b171 100644 --- a/docs/reference/esql/functions/kibana/docs/tan.md +++ b/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 Tangent trigonometric function of an angle. +Returns the tangent of an angle. ``` ROW a=1.8 diff --git a/docs/reference/esql/functions/kibana/docs/tanh.md b/docs/reference/esql/functions/kibana/docs/tanh.md index c4a70dec00ba8..365add190de82 100644 --- a/docs/reference/esql/functions/kibana/docs/tanh.md +++ b/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 Tangent hyperbolic function of an angle. +Returns the hyperbolic tangent of a number. ``` ROW a=1.8 diff --git a/docs/reference/esql/functions/parameters/cosh.asciidoc b/docs/reference/esql/functions/parameters/cosh.asciidoc index a1c3f7edf30ce..65013f4c21265 100644 --- a/docs/reference/esql/functions/parameters/cosh.asciidoc +++ b/docs/reference/esql/functions/parameters/cosh.asciidoc @@ -2,5 +2,5 @@ *Parameters* -`angle`:: -An angle, in radians. If `null`, the function returns `null`. +`number`:: +Numeric expression. If `null`, the function returns `null`. diff --git a/docs/reference/esql/functions/parameters/sinh.asciidoc b/docs/reference/esql/functions/parameters/sinh.asciidoc index a1c3f7edf30ce..65013f4c21265 100644 --- a/docs/reference/esql/functions/parameters/sinh.asciidoc +++ b/docs/reference/esql/functions/parameters/sinh.asciidoc @@ -2,5 +2,5 @@ *Parameters* -`angle`:: -An angle, in radians. If `null`, the function returns `null`. +`number`:: +Numeric expression. If `null`, the function returns `null`. diff --git a/docs/reference/esql/functions/parameters/tanh.asciidoc b/docs/reference/esql/functions/parameters/tanh.asciidoc index a1c3f7edf30ce..65013f4c21265 100644 --- a/docs/reference/esql/functions/parameters/tanh.asciidoc +++ b/docs/reference/esql/functions/parameters/tanh.asciidoc @@ -2,5 +2,5 @@ *Parameters* -`angle`:: -An angle, in radians. If `null`, the function returns `null`. +`number`:: +Numeric expression. If `null`, the function returns `null`. diff --git a/docs/reference/esql/functions/signature/cosh.svg b/docs/reference/esql/functions/signature/cosh.svg index 11b14d922929a..9b9eddd3cb808 100644 --- a/docs/reference/esql/functions/signature/cosh.svg +++ b/docs/reference/esql/functions/signature/cosh.svg @@ -1 +1 @@ -COSH(angle) \ No newline at end of file +COSH(number) \ No newline at end of file diff --git a/docs/reference/esql/functions/signature/sinh.svg b/docs/reference/esql/functions/signature/sinh.svg index 0bb4ac31dee30..16e7ddb6b6534 100644 --- a/docs/reference/esql/functions/signature/sinh.svg +++ b/docs/reference/esql/functions/signature/sinh.svg @@ -1 +1 @@ -SINH(angle) \ No newline at end of file +SINH(number) \ No newline at end of file diff --git a/docs/reference/esql/functions/signature/tanh.svg b/docs/reference/esql/functions/signature/tanh.svg index f7b968f8b30c4..c2edfe2d6942f 100644 --- a/docs/reference/esql/functions/signature/tanh.svg +++ b/docs/reference/esql/functions/signature/tanh.svg @@ -1 +1 @@ -TANH(angle) \ No newline at end of file +TANH(number) \ No newline at end of file diff --git a/docs/reference/esql/functions/types/cosh.asciidoc b/docs/reference/esql/functions/types/cosh.asciidoc index d96a34b678531..7cda278abdb56 100644 --- a/docs/reference/esql/functions/types/cosh.asciidoc +++ b/docs/reference/esql/functions/types/cosh.asciidoc @@ -4,7 +4,7 @@ [%header.monospaced.styled,format=dsv,separator=|] |=== -angle | result +number | result double | double integer | double long | double diff --git a/docs/reference/esql/functions/types/sinh.asciidoc b/docs/reference/esql/functions/types/sinh.asciidoc index d96a34b678531..7cda278abdb56 100644 --- a/docs/reference/esql/functions/types/sinh.asciidoc +++ b/docs/reference/esql/functions/types/sinh.asciidoc @@ -4,7 +4,7 @@ [%header.monospaced.styled,format=dsv,separator=|] |=== -angle | result +number | result double | double integer | double long | double diff --git a/docs/reference/esql/functions/types/tanh.asciidoc b/docs/reference/esql/functions/types/tanh.asciidoc index d96a34b678531..7cda278abdb56 100644 --- a/docs/reference/esql/functions/types/tanh.asciidoc +++ b/docs/reference/esql/functions/types/tanh.asciidoc @@ -4,7 +4,7 @@ [%header.monospaced.styled,format=dsv,separator=|] |=== -angle | result +number | result double | double integer | double long | double