[
https://issues.apache.org/jira/browse/SPARK-23329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16355155#comment-16355155
]
Mihaly Toth commented on SPARK-23329:
-------------------------------------
Nice. I like that the redundant description part is simply omitted.
The only issue I see is that {{e}} is actually not an angle. At least we could
put it into plural, like:
{code}
/**
* @param e angles in radians
* @return sines of the angles, as if computed by [[java.lang.Math.sin]]
* ...
*/
{code}
I was also thinking about mentioning that it is actually a Column does not
inflate the lines very much. At the same time they are more precise.
{code}
/**
* @param e [[Column]] of angles in radians
* @return [[Column]] of sines of the angles, as if computed by
[[java.lang.Math.sin]]
* ...
*/
{code}
Now looking at this the first one seems better because it tells truth and one
can figure out easily that the angles are stored in a Column.
> 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: [email protected]
For additional commands, e-mail: [email protected]
