techdocsmith commented on code in PR #16795: URL: https://github.com/apache/druid/pull/16795#discussion_r1690534132
########## docs/querying/sql-functions.md: ########## @@ -70,11 +70,26 @@ Returns the following: ## ACOS -`ACOS(<NUMERIC>)` +Calculates the arc cosine of a numeric expression. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `ACOS(expr)` +* **Function type:** Scalar, numeric -Calculates the arc cosine of a numeric expression. +<details><summary>Example</summary> + +The following example calculates the arc cosine of zero. + +```sql +SELECT ACOS(0) AS "arc_cosine" +``` +Returns the following: + +| `arc_tangent` | Review Comment: ```suggestion | `arc_cosine` | ``` make sure your column names match your alias. this looks like maybe cp/paste . ########## docs/querying/sql-functions.md: ########## @@ -70,11 +70,26 @@ Returns the following: ## ACOS -`ACOS(<NUMERIC>)` +Calculates the arc cosine of a numeric expression. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `ACOS(expr)` +* **Function type:** Scalar, numeric -Calculates the arc cosine of a numeric expression. +<details><summary>Example</summary> + +The following example calculates the arc cosine of zero. Review Comment: ```suggestion The following example calculates the arc cosine (arccosine) of zero. ``` Maybe include the variant spelling in case someone searches? ########## docs/querying/sql-functions.md: ########## @@ -280,27 +295,72 @@ Joins all elements of `arr` by the delimiter specified by `str`. ## ASIN -`ASIN(<NUMERIC>)` +Calculates the arc sine of a numeric expression. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `ASIN(expr)` +* **Function type:** Scalar, numeric -Calculates the arc sine of a numeric expression. +<details><summary>Example</summary> -## ATAN +The following example calculates the arc sine of one. -`ATAN(<NUMERIC>)` +```sql +SELECT ASIN(1) AS "arc_sine" +``` +Returns the following: -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +| `arc_sine` | +| -- | +| `1.5707963267948966` | +</details> + +[Learn more](sql-scalar.md#numeric-functions) + +## ATAN Calculates the arc tangent of a numeric expression. +* **Syntax:** `ATAN(expr)` +* **Function type:** Scalar, numeric + +<details><summary>Example</summary> + +The following example calculates the arc tangent of one. + +```sql +SELECT ATAN(1) AS "arc_tangent" +``` +Returns the following: + +| `arc_tangent` | +| -- | +| `0.7853981633974483` | +</details> + +[Learn more](sql-scalar.md#numeric-functions) + ## ATAN2 -`ATAN2(<NUMERIC>, <NUMERIC>)` +Calculates the arc tangent of specified x and y coordinates. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `ATAN2(x, y)` +* **Function type:** Scalar, numeric + +<details><summary>Example</summary> + +The following example calculates the arc tangent of the coordinate (1, -1) + +```sql +SELECT ATAN2(1,-1) AS "arc_tangent_2" +``` +Returns the following: + +| `arc_tangent` | Review Comment: ```suggestion | `arc_tangent_2` | ``` make sure your aliases match your results ########## docs/querying/sql-functions.md: ########## @@ -280,27 +295,72 @@ Joins all elements of `arr` by the delimiter specified by `str`. ## ASIN -`ASIN(<NUMERIC>)` +Calculates the arc sine of a numeric expression. Review Comment: ```suggestion Calculates the arc sine (arcsine) of a numeric expression. ``` ########## docs/querying/sql-functions.md: ########## @@ -280,27 +295,72 @@ Joins all elements of `arr` by the delimiter specified by `str`. ## ASIN -`ASIN(<NUMERIC>)` +Calculates the arc sine of a numeric expression. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `ASIN(expr)` +* **Function type:** Scalar, numeric -Calculates the arc sine of a numeric expression. +<details><summary>Example</summary> -## ATAN +The following example calculates the arc sine of one. -`ATAN(<NUMERIC>)` +```sql +SELECT ASIN(1) AS "arc_sine" +``` +Returns the following: -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +| `arc_sine` | +| -- | +| `1.5707963267948966` | +</details> + +[Learn more](sql-scalar.md#numeric-functions) + +## ATAN Calculates the arc tangent of a numeric expression. +* **Syntax:** `ATAN(expr)` +* **Function type:** Scalar, numeric + +<details><summary>Example</summary> + +The following example calculates the arc tangent of one. Review Comment: ```suggestion The following example calculates the arc tangent (arctangent) of one. ``` ########## docs/querying/sql-functions.md: ########## @@ -514,20 +574,50 @@ Finds whether a string is in a given expression, case-sensitive. ## COS -`COS(<NUMERIC>)` +Calculates the trigonometric cosine of an angle expressed in radians. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `COS(expr)` +* **Function type:** Scalar, numeric -Calculates the trigonometric cosine of an angle expressed in radians. +<details><summary>Example</summary> -## COT +The following example calculates the cosine of `PI` over three radians. Review Comment: Suggest mentioning the angle in the example description. Suggest using numeric notation the radian ( π/3 ) > The following example calculates the cosine for an angle of π/3 radians. ########## docs/querying/sql-functions.md: ########## @@ -280,27 +295,72 @@ Joins all elements of `arr` by the delimiter specified by `str`. ## ASIN -`ASIN(<NUMERIC>)` +Calculates the arc sine of a numeric expression. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `ASIN(expr)` +* **Function type:** Scalar, numeric -Calculates the arc sine of a numeric expression. +<details><summary>Example</summary> -## ATAN +The following example calculates the arc sine of one. -`ATAN(<NUMERIC>)` +```sql +SELECT ASIN(1) AS "arc_sine" +``` +Returns the following: -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +| `arc_sine` | +| -- | +| `1.5707963267948966` | +</details> + +[Learn more](sql-scalar.md#numeric-functions) + +## ATAN Calculates the arc tangent of a numeric expression. +* **Syntax:** `ATAN(expr)` +* **Function type:** Scalar, numeric + +<details><summary>Example</summary> + +The following example calculates the arc tangent of one. + +```sql +SELECT ATAN(1) AS "arc_tangent" +``` +Returns the following: + +| `arc_tangent` | +| -- | +| `0.7853981633974483` | +</details> + +[Learn more](sql-scalar.md#numeric-functions) + ## ATAN2 -`ATAN2(<NUMERIC>, <NUMERIC>)` +Calculates the arc tangent of specified x and y coordinates. Review Comment: ```suggestion Calculates the arc tangent (arctangent) of specified x and y coordinates. ``` ########## docs/querying/sql-functions.md: ########## @@ -514,20 +574,50 @@ Finds whether a string is in a given expression, case-sensitive. ## COS -`COS(<NUMERIC>)` +Calculates the trigonometric cosine of an angle expressed in radians. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `COS(expr)` +* **Function type:** Scalar, numeric -Calculates the trigonometric cosine of an angle expressed in radians. +<details><summary>Example</summary> -## COT +The following example calculates the cosine of `PI` over three radians. -`COT(<NUMERIC>)` +```sql +SELECT COS(PI / 3) AS "cosine" +``` +Returns the following: -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +| `COS` | Review Comment: make sure that your alias (line 587) matches your output ########## docs/querying/sql-functions.md: ########## @@ -280,27 +295,72 @@ Joins all elements of `arr` by the delimiter specified by `str`. ## ASIN -`ASIN(<NUMERIC>)` +Calculates the arc sine of a numeric expression. -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +* **Syntax:** `ASIN(expr)` +* **Function type:** Scalar, numeric -Calculates the arc sine of a numeric expression. +<details><summary>Example</summary> -## ATAN +The following example calculates the arc sine of one. -`ATAN(<NUMERIC>)` +```sql +SELECT ASIN(1) AS "arc_sine" +``` +Returns the following: -**Function type:** [Scalar, numeric](sql-scalar.md#numeric-functions) +| `arc_sine` | +| -- | +| `1.5707963267948966` | +</details> + +[Learn more](sql-scalar.md#numeric-functions) + +## ATAN Calculates the arc tangent of a numeric expression. Review Comment: Why are some functions explicitly called out as `trigonometric` (line 577) and others not? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
