[MINOR][DOC] Fix the CalendarIntervalType description
### What changes were proposed in this pull request? fix the overdue and incorrect description about CalendarIntervalType ### Why are the changes needed? api doc correctness ### Does this PR introduce any user-facing change? no ### How was this patch tested? no Closes #26659 from yaooqinn/intervaldoc. Authored-by: Kent Yao <yaooqinn@hotmail.com> Signed-off-by: Wenchen Fan <wenchen@databricks.com>
This commit is contained in:
parent
53e19f3678
commit
8b0121bea8
|
@ -21,12 +21,15 @@ import org.apache.spark.annotation.Stable
|
||||||
import org.apache.spark.unsafe.types.CalendarInterval
|
import org.apache.spark.unsafe.types.CalendarInterval
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The data type representing calendar time intervals. The calendar time interval is stored
|
* The data type representing calendar intervals. The calendar interval is stored internally in
|
||||||
* internally in two components: number of months the number of microseconds.
|
* 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
|
* @since 1.5.0
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in a new issue