[ https://issues.apache.org/jira/browse/SPARK-23329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16354178#comment-16354178 ]
Sean Owen commented on SPARK-23329: ----------------------------------- Sure, though I might simplify that a bit. {code} /** * @param e angle in radians * @return sine of the angle, as if computed by [[java.lang.Math.sin]] * ... */ {code} Perhaps this can be limited to improving the documentation of all trigonometric functions. > Update the function descriptions with the arguments and returned values of > the trigonometric functions > ------------------------------------------------------------------------------------------------------ > > Key: SPARK-23329 > URL: https://issues.apache.org/jira/browse/SPARK-23329 > Project: Spark > Issue Type: Documentation > Components: SQL > Affects Versions: 2.3.0 > Reporter: Xiao Li > Priority: Minor > Labels: starter > > We need an update on the function descriptions for all the trigonometric > functions. For example, {{cos}}, {{sin}}, and {{cot}}. Internally, the > implementation is based on the java.lang.Math. We need a clear description > about the units of the input arguments and the returned values. > For example, the following descriptions are lacking such info. > https://github.com/apache/spark/blob/master/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala#L551-L555 > https://github.com/apache/spark/blob/d5861aba9d80ca15ad3f22793b79822e470d6913/sql/core/src/main/scala/org/apache/spark/sql/functions.scala#L1978 -- This message was sent by Atlassian JIRA (v7.6.3#76005) --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org