Skip to content

Commit

Permalink
Add additional documentation for UTC representation of timestamps (#6994
Browse files Browse the repository at this point in the history
)

* docs(arrow-schema): add additional documentation regarding UTC representation

* docs(arrow-schema): clearer docs

* fix: whitespaces
  • Loading branch information
Abdullahsab3 authored Jan 21, 2025
1 parent 4b38ff5 commit 595a835
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions arrow-schema/src/datatype.rs
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,13 @@ pub enum DataType {
/// DataType::Timestamp(TimeUnit::Second, Some("literal".into()));
/// DataType::Timestamp(TimeUnit::Second, Some("string".to_string().into()));
/// ```
/// For UTC time
/// ----------------------------
/// For UTC time, it is possible to use either the timezone representation, such as "UTC", or the absolute time zone offset "+00:00".
/// However, it is better to use the offset representation, as it is more explicit and less ambiguous.
/// This also ensures that other arrow-rs functionalities can interpret the UTC timestamps correctly
/// For example, the `with_timezone_utc` method that is applied on timestamp arrays to add the UTC timezone.
///
///
/// Timezone string parsing
/// -----------------------
Expand Down

0 comments on commit 595a835

Please sign in to comment.