Github user HyukjinKwon commented on a diff in the pull request:
https://github.com/apache/spark/pull/18749#discussion_r129802019
--- Diff:
sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java
---
@@ -29,15 +29,40 @@
* show the usage of the function in human language.
*
* `usage()` will be used for the function usage in brief way.
- * `extended()` will be used for the function usage in verbose way, suppose
- * an example will be provided.
*
- * And we can refer the function name by `_FUNC_`, in `usage` and
`extended`, as it's
+ * These below are concatenated and used for the function usage in verbose
way, suppose arguments,
+ * examples, note and since will be provided.
+ *
+ * `arguments()` describes arguments for the expression. This should
follow the format as below:
+ *
+ * Arguments:
+ * * arg0 - ...
+ * ....
+ * * arg1 - ...
+ * ....
+ *
+ * `examples()` describes examples for the expression. This should follow
the format as below:
+ *
+ * Examples:
+ * > SELECT ...;
+ * ...
+ * > SELECT ...;
+ * ...
+ *
+ * `note()` contains some notes for the expression optionally.
+ *
+ * `since()` contains version information for the expression. Version is
specified by,
+ * for example, "2.2.0".
+ *
+ * We can refer the function name by `_FUNC_`, in `usage`, `arguments`
and `examples`, as it's
* registered in `FunctionRegistry`.
*/
@DeveloperApi
@Retention(RetentionPolicy.RUNTIME)
public @interface ExpressionDescription {
--- End diff --
I believe we are okay to change this -
https://github.com/apache/spark/blob/425c4ada4c24e338b45d0e9987071f05c5766fa5/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/package.scala#L22
and I could not find this in documentation.
---
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 [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
