diff --git a/sql/catalyst/src/main/scala/org/apache/spark/sql/types/CalendarIntervalType.scala b/sql/catalyst/src/main/scala/org/apache/spark/sql/types/CalendarIntervalType.scala index 8a9a2e246a30b..641fb354dd322 100644 --- a/sql/catalyst/src/main/scala/org/apache/spark/sql/types/CalendarIntervalType.scala +++ b/sql/catalyst/src/main/scala/org/apache/spark/sql/types/CalendarIntervalType.scala @@ -21,12 +21,15 @@ import org.apache.spark.annotation.Stable import org.apache.spark.unsafe.types.CalendarInterval /** - * The data type representing calendar time intervals. The calendar time interval is stored - * internally in two components: number of months the number of microseconds. + * The data type representing calendar intervals. The calendar interval is stored internally in + * three components: + * an integer value representing the number of `months` in this interval, + * an integer value representing the number of `days` in this interval, + * a long value representing the number of `microseconds` in this interval. * - * Please use the singleton `DataTypes.CalendarIntervalType`. + * Please use the singleton `DataTypes.CalendarIntervalType` to refer the type. * - * @note Calendar intervals are not comparable. + * @note Calendar intervals support comparison and ordering since 3.0.0. * * @since 1.5.0 */