[SPARK-23329] Update the function descriptions with the arguments and returned values of the trigonometric functions

• Type: Documentation
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.3.0
• Fix Version/s: 2.3.1, 2.4.0
• Component/s: SQL
• Labels: starter
• Assignee: Mihaly Toth
• Reporter: Xiao Li
• Created: 03/Feb/18 19:25
• Updated: 12/Dec/22 18:10
• Resolved: 05/Mar/18 14:49

Description

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

Issue Links

• links to: [Github] Pull Request #20618 (misutoth)