# [GitHub] spark pull request #20618: [SPARK-23329][SQL] Fix documentation of trigonome...

```Github user HyukjinKwon commented on a diff in the pull request:

https://github.com/apache/spark/pull/20618#discussion_r171836519

--- Diff: sql/core/src/main/scala/org/apache/spark/sql/functions.scala ---
@@ -1313,131 +1313,165 @@ object functions {

//////////////////////////////////////////////////////////////////////////////////////////////

/**
-   * Computes the cosine inverse of the given value; the returned angle is
in the range
-   * 0.0 through pi.
+   * @return inverse cosine of `e` in radians, as if computed by
[[java.lang.Math#acos]]
*
* @group math_funcs
* @since 1.4.0
*/
def acos(e: Column): Column = withExpr { Acos(e.expr) }

/**
-   * Computes the cosine inverse of the given column; the returned angle
is in the range
-   * 0.0 through pi.
+   * @return inverse cosine of `columnName`, as if computed by
[[java.lang.Math#acos]]
*
* @group math_funcs
* @since 1.4.0
*/
def acos(columnName: String): Column = acos(Column(columnName))

/**
-   * Computes the sine inverse of the given value; the returned angle is
in the range
-   * -pi/2 through pi/2.
+   * @return inverse sine of `e` in radians, as if computed by
[[java.lang.Math#asin]]
*
* @group math_funcs
* @since 1.4.0
*/
def asin(e: Column): Column = withExpr { Asin(e.expr) }

/**
-   * Computes the sine inverse of the given column; the returned angle is
in the range
-   * -pi/2 through pi/2.
+   * @return inverse sine of `columnName`, as if computed by
[[java.lang.Math#asin]]
*
* @group math_funcs
* @since 1.4.0
*/
def asin(columnName: String): Column = asin(Column(columnName))

/**
-   * Computes the tangent inverse of the given column; the returned angle
is in the range
-   * -pi/2 through pi/2
+   * @return inverse tangent of `e`, as if computed by
[[java.lang.Math#atan]]
*
* @group math_funcs
* @since 1.4.0
*/
def atan(e: Column): Column = withExpr { Atan(e.expr) }

/**
-   * Computes the tangent inverse of the given column; the returned angle
is in the range
-   * -pi/2 through pi/2
+   * @return inverse tangent of `columnName`, as if computed by
[[java.lang.Math#atan]]
*
* @group math_funcs
* @since 1.4.0
*/
def atan(columnName: String): Column = atan(Column(columnName))

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta). Units in radians.
+   * @param y coordinate on y-axis
+   * @param x coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
+   *         in polar coordinates that corresponds to the point
+   *         (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
+   *         as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
-  def atan2(l: Column, r: Column): Column = withExpr { Atan2(l.expr,
r.expr) }
+  def atan2(y: Column, x: Column): Column = withExpr { Atan2(y.expr,
x.expr) }

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta).
+   * @param y coordinate on y-axis
+   * @param xName coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
+   *         in polar coordinates that corresponds to the point
+   *         (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
+   *         as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
-  def atan2(l: Column, rightName: String): Column = atan2(l,
Column(rightName))
+  def atan2(y: Column, xName: String): Column = atan2(y, Column(xName))

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta).
+   * @param yName coordinate on y-axis
+   * @param x coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
+   *         in polar coordinates that corresponds to the point
+   *         (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
+   *         as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
-  def atan2(leftName: String, r: Column): Column = atan2(Column(leftName),
r)
+  def atan2(yName: String, x: Column): Column = atan2(Column(yName), x)

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta).
+   * @param yName coordinate on y-axis
+   * @param xName coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
+   *         in polar coordinates that corresponds to the point
+   *         (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
+   *         as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
-  def atan2(leftName: String, rightName: String): Column =
-    atan2(Column(leftName), Column(rightName))
+  def atan2(yName: String, xName: String): Column =
+    atan2(Column(yName), Column(xName))

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta).
+   * @param y coordinate on y-axis
+   * @param xValue coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
+   *         in polar coordinates that corresponds to the point
+   *         (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
+   *         as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
-  def atan2(l: Column, r: Double): Column = atan2(l, lit(r))
+  def atan2(y: Column, xValue: Double): Column = atan2(y, lit(xValue))

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta).
+   * @param yName coordinate on y-axis
+   * @param xValue coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
+   *         in polar coordinates that corresponds to the point
+   *         (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
+   *         as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
-  def atan2(leftName: String, r: Double): Column = atan2(Column(leftName),
r)
+  def atan2(yName: String, xValue: Double): Column = atan2(Column(yName),
xValue)

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta).
+   * @param yValue coordinate on y-axis
+   * @param x coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
+   *         in polar coordinates that corresponds to the point
+   *         (<i>x</i>,&nbsp;<i>y</i>) in Cartesian coordinates,
+   *         as if computed by [[java.lang.Math#atan2]]
*
* @group math_funcs
* @since 1.4.0
*/
-  def atan2(l: Double, r: Column): Column = atan2(lit(l), r)
+  def atan2(yValue: Double, x: Column): Column = atan2(lit(yValue), x)

/**
-   * Returns the angle theta from the conversion of rectangular
coordinates (x, y) to
-   * polar coordinates (r, theta).
+   * @param yValue coordinate on y-axis
+   * @param xName coordinate on x-axis
+   * @return the <i>theta</i> component of the point
+   *         (<i>r</i>,&nbsp;<i>theta</i>)
--- End diff --

nit `&nbsp;` -> ` `. Seems broken in Javadoc.```
```

---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org