-
Notifications
You must be signed in to change notification settings - Fork 810
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.
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
Update docs for datatypes #5260
Conversation
@@ -23,14 +23,18 @@ use crate::{Field, FieldRef, Fields, UnionFields}; | |||
/// The set of datatypes that are supported by this implementation of Apache Arrow. | |||
/// | |||
/// The Arrow specification on data types includes some more types. | |||
/// See also [`Schema.fbs`](https://github.com/apache/arrow/blob/master/format/Schema.fbs) | |||
/// See also [`Schema.fbs`](https://github.com/apache/arrow/blob/main/format/Schema.fbs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
arrow-schema/src/datatype.rs
Outdated
/// Must be either seconds or millieseconds. | ||
Time32(TimeUnit), | ||
/// A 64-bit time representing the elapsed time since midnight in the unit of `TimeUnit`. | ||
/// Must be either microseconds or nanoseconds. | ||
Time64(TimeUnit), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Want to be explicit here as in isolation it can imply Time64 could take on seconds/milliseconds and Time32 could take on microseconds/nanoseconds based on TimeUnit enum alone
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @Jefffrey ❤️
There is one typo but otherwise this PR looks good to go to me
/// for Arrow's specification. | ||
/// | ||
/// The variants of this enum include primitive fixed size types as well as parametric or | ||
/// nested types. | ||
/// Currently the Rust implementation supports the following nested types: | ||
/// Currently the Rust implementation supports the following nested types: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Co-authored-by: Andrew Lamb <[email protected]>
Which issue does this PR close?
Closes #.
Rationale for this change
Update docs for datatypes
What changes are included in this PR?
Are there any user-facing changes?