[GitHub] [spark] cloud-fan commented on a change in pull request #24259: [SPARK-27328][SQL] Add 'deprecated' in ExpressionDescription for extended usage and SQL doc

[GitBox <gi...@apache.org>]

cloud-fan commented on a change in pull request #24259: [SPARK-27328][SQL] Add 'deprecated' in ExpressionDescription for extended usage and SQL doc
URL: https://github.com/apache/spark/pull/24259#discussion_r270738686
 
 

 ##########
 File path: sql/catalyst/src/main/java/org/apache/spark/sql/catalyst/expressions/ExpressionDescription.java
 ##########
 @@ -49,17 +49,21 @@
  *     > SELECT ...;
  *      ...
  *
- * `note()` contains some notes for the expression optionally.
+ * `note()` contains some notes for the expression optionally. This property should have 4
+ * leading spaces and end with a newline.
  *
  * `since()` contains version information for the expression. Version is specified by,
- * for example, "2.2.0".
+ * for example, "2.2.0". It should not start with non-number characters.
+ *
+ * `deprecated()` contains deprecation information for the expression optionally, for example,
+ * "Deprecated since 2.2.0. Use something else instead". This property should have 4
 
 Review comment:
   not related to this PR, but why do we have such a weird requirement for the text?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org