-
- Downloads
[SPARK-21485][FOLLOWUP][SQL][DOCS] Describes examples and arguments...
[SPARK-21485][FOLLOWUP][SQL][DOCS] Describes examples and arguments separately, and note/since in SQL built-in function documentation ## What changes were proposed in this pull request? This PR proposes to separate `extended` into `examples` and `arguments` internally so that both can be separately documented and add `since` and `note` for additional information. For `since`, it looks users sometimes get confused by, up to my knowledge, missing version information. For example, see https://www.mail-archive.com/userspark.apache.org/msg64798.html For few good examples to check the built documentation, please see both: `from_json` - https://spark-test.github.io/sparksqldoc/#from_json `like` - https://spark-test.github.io/sparksqldoc/#like For `DESCRIBE FUNCTION`, `note` and `since` are added as below: ``` > DESCRIBE FUNCTION EXTENDED rlike; ... Extended Usage: Arguments: ... Examples: ... Note: Use LIKE to match with simple string pattern ``` ``` > DESCRIBE FUNCTION EXTENDED to_json; ... Examples: ... Since: 2.2.0 ``` For the complete documentation, see https://spark-test.github.io/sparksqldoc/ ## How was this patch tested? Manual tests and existing tests. Please see https://spark-test.github.io/sparksqldoc Jenkins tests are needed to double check Author: hyukjinkwon <gurwls223@gmail.com> Closes #18749 from HyukjinKwon/followup-sql-doc-gen.
Showing
- sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java 36 additions, 6 deletions...spark/sql/catalyst/expressions/ExpressionDescription.java
- sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionInfo.java 61 additions, 4 deletions...apache/spark/sql/catalyst/expressions/ExpressionInfo.java
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/analysis/FunctionRegistry.scala 18 additions, 2 deletions...apache/spark/sql/catalyst/analysis/FunctionRegistry.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/CallMethodViaReflection.scala 1 addition, 1 deletion...rk/sql/catalyst/expressions/CallMethodViaReflection.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/Cast.scala 1 addition, 1 deletion...cala/org/apache/spark/sql/catalyst/expressions/Cast.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/aggregate/ApproximatePercentile.scala 1 addition, 1 deletion...atalyst/expressions/aggregate/ApproximatePercentile.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/arithmetic.scala 10 additions, 10 deletions...rg/apache/spark/sql/catalyst/expressions/arithmetic.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/bitwiseExpressions.scala 4 additions, 4 deletions...e/spark/sql/catalyst/expressions/bitwiseExpressions.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/collectionOperations.scala 5 additions, 5 deletions...spark/sql/catalyst/expressions/collectionOperations.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/complexTypeCreator.scala 7 additions, 4 deletions...e/spark/sql/catalyst/expressions/complexTypeCreator.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/conditionalExpressions.scala 1 addition, 1 deletion...ark/sql/catalyst/expressions/conditionalExpressions.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/datetimeExpressions.scala 26 additions, 26 deletions.../spark/sql/catalyst/expressions/datetimeExpressions.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/generators.scala 4 additions, 4 deletions...rg/apache/spark/sql/catalyst/expressions/generators.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/hash.scala 5 additions, 5 deletions...cala/org/apache/spark/sql/catalyst/expressions/hash.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/jsonExpressions.scala 8 additions, 6 deletions...ache/spark/sql/catalyst/expressions/jsonExpressions.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/mathExpressions.scala 40 additions, 40 deletions...ache/spark/sql/catalyst/expressions/mathExpressions.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/misc.scala 3 additions, 3 deletions...cala/org/apache/spark/sql/catalyst/expressions/misc.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/nullExpressions.scala 9 additions, 9 deletions...ache/spark/sql/catalyst/expressions/nullExpressions.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/randomExpressions.scala 2 additions, 2 deletions...he/spark/sql/catalyst/expressions/randomExpressions.scala
- sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/regexpExpressions.scala 36 additions, 33 deletions...he/spark/sql/catalyst/expressions/regexpExpressions.scala
Loading
Please register or sign in to comment