Github user srowen commented on a diff in the pull request:
https://github.com/apache/spark/pull/15513#discussion_r84573933
--- Diff:
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala
---
@@ -159,28 +167,69 @@ case class Pi() extends LeafMathExpression(math.Pi,
"PI")
////////////////////////////////////////////////////////////////////////////////////////////////////
@ExpressionDescription(
- usage = "_FUNC_(x) - Returns the arc cosine of x if -1<=x<=1 or NaN
otherwise.",
- extended = "> SELECT _FUNC_(1);\n 0.0\n> SELECT _FUNC_(2);\n NaN")
+ usage = "_FUNC_(expr) - Returns the arc cosine of expr if -1<=expr<=1 or
NaN otherwise.",
+ extended = """
+ Arguments:
+ expr - a numeric expression.
+
+ Examples:
+ > SELECT _FUNC_(1);
+ 0.0
+ > SELECT _FUNC_(2);
+ NaN
+ """)
case class Acos(child: Expression) extends UnaryMathExpression(math.acos,
"ACOS")
@ExpressionDescription(
- usage = "_FUNC_(x) - Returns the arc sin of x if -1<=x<=1 or NaN
otherwise.",
- extended = "> SELECT _FUNC_(0);\n 0.0\n> SELECT _FUNC_(2);\n NaN")
+ usage = "_FUNC_(expr) - Returns the arc sin of expr if -1<=expr<=1 or
NaN otherwise.",
+ extended = """
+ Arguments:
+ expr - a numeric expression.
+
+ Examples:
+ > SELECT _FUNC_(0);
+ 0.0
+ > SELECT _FUNC_(2);
+ NaN
+ """)
case class Asin(child: Expression) extends UnaryMathExpression(math.asin,
"ASIN")
@ExpressionDescription(
- usage = "_FUNC_(x) - Returns the arc tangent.",
- extended = "> SELECT _FUNC_(0);\n 0.0")
+ usage = "_FUNC_(expr) - Returns the arc tangent.",
+ extended = """
+ Arguments:
+ expr - a numeric expression.
+
+ Examples:
+ > SELECT _FUNC_(0);
+ 0.0
+ """)
case class Atan(child: Expression) extends UnaryMathExpression(math.atan,
"ATAN")
@ExpressionDescription(
- usage = "_FUNC_(x) - Returns the cube root of a double value.",
- extended = "> SELECT _FUNC_(27.0);\n 3.0")
+ usage = "_FUNC_(expr) - Returns the cube root of a double value.",
--- End diff --
Must it be a 'double' since that refers to a specific type? just say "of a
value"?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
