dongjoon-hyun commented on a change in pull request #27258: [SPARK-30547][SQL] 
Add unstable annotation to the CalendarInterval class
URL: https://github.com/apache/spark/pull/27258#discussion_r368370344
 
 

 ##########
 File path: 
common/unsafe/src/main/java/org/apache/spark/unsafe/types/CalendarInterval.java
 ##########
 @@ -27,8 +29,21 @@
 import static org.apache.spark.sql.catalyst.util.DateTimeConstants.*;
 
 /**
- * The internal representation of interval type.
+ * The class representing calendar intervals. The calendar interval is stored 
internally in
+ * three components:
+ * <ul>
+ *   <li>an integer value representing the number of `months` in this 
interval,</li>
+ *   <li>an integer value representing the number of `days` in this 
interval,</li>
+ *   <li>a long value representing the number of `microseconds` in this 
interval.</li>
+ * </ul>
+ *
+ * The `months` and `days` are not units of time with a constant length 
(unlike hours, seconds), so
+ * they are two separated fields from microseconds. One month may be equal to 
28, 29, 30 or 31 days
+ * and one day may be equal to 23, 24 or 25 hours (daylight saving).
+ *
+ * @since 1.5.0
 
 Review comment:
   Just a question: @cloud-fan .
   Although this is technically correct, if this is going to **public**  in 
`3.00`, `@since 3.0.0` is better?

----------------------------------------------------------------
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:
us...@infra.apache.org


With regards,
Apache Git Services

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

Reply via email to