Github user srowen commented on a diff in the pull request:
https://github.com/apache/spark/pull/20618#discussion_r169086344
--- Diff: sql/core/src/main/scala/org/apache/spark/sql/functions.scala ---
@@ -1313,131 +1313,168 @@ object functions {
//////////////////////////////////////////////////////////////////////////////////////////////
/**
- * Computes the cosine inverse of the given value; the returned angle is
in the range
- * 0.0 through pi.
+ * @return angle in radians whose cosine is `e`, as if computed by
[[java.lang.Math#acos]]
*
* @group math_funcs
* @since 1.4.0
*/
def acos(e: Column): Column = withExpr { Acos(e.expr) }
+ // scalastyle:off line.size.limit
/**
- * Computes the cosine inverse of the given column; the returned angle
is in the range
- * 0.0 through pi.
+ * @return angle in radians whose cosine is `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 angle in radians whose sine is `e`, 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 angle in radians whose sine is `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 angle in radians whose tangent is `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) }
+ // scalastyle:off line.size.limit
/**
- * Computes the tangent inverse of the given column; the returned angle
is in the range
- * -pi/2 through pi/2
+ * @return angle in radians whose tangent is `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.
+ *
--- End diff --
Tiny nit: remove this first blank line.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
