Skip to content

[MINOR][DOC] Fix the CalendarIntervalType description #26659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yaooqinn wants to merge 3 commits into from
Closed

[MINOR][DOC] Fix the CalendarIntervalType description #26659

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c2f5e3
[MINOR][DOC] Fix the CalendarIntervalType description
yaooqinn Nov 25, 2019
ac613bb
fix doc gen
yaooqinn Nov 25, 2019
6a95931
improve doc
yaooqinn Nov 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/types/CalendarIntervalType.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,14 @@ import org.apache.spark.unsafe.types.CalendarInterval

/**
* The data type representing calendar time intervals. The calendar time interval is stored

@MaxGekk MaxGekk Nov 25, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

representing -> represents? @srowen Does representing sound good for you?

@srowen srowen Nov 25, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

representing sounds right. "[This class is] The data type representing ..."

@MaxGekk MaxGekk Nov 25, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

calendar time intervals . It is arguable but it can represent date interval too.

* internally in two components: number of months the number of microseconds.
* internally in three components:
* the number of months

@MaxGekk MaxGekk Nov 25, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should say explicitly that the numbers can be positive as well as negative

* the number of days
* the number of microseconds.
*
* 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
*/
Expand Down