doc: add comment for timezone string (apache#6899)

* doc: add comment for timezone string Signed-off-by: xxchan <[email protected]> * Update arrow-schema/src/datatype.rs Co-authored-by: Raphael Taylor-Davies <[email protected]> --------- Signed-off-by: xxchan <[email protected]> Co-authored-by: Raphael Taylor-Davies <[email protected]>
jagill · Dec 18, 2024 · fc814bc · fc814bc
1 parent cbe1765
commit fc814bc
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/arrow-schema/src/datatype.rs b/arrow-schema/src/datatype.rs
@@ -196,6 +196,14 @@ pub enum DataType {
     /// DataType::Timestamp(TimeUnit::Second, Some("literal".into()));
     /// DataType::Timestamp(TimeUnit::Second, Some("string".to_string().into()));
     /// ```
+    ///
+    /// Timezone string parsing
+    /// -----------------------
+    /// When feature `chrono-tz` is not enabled, allowed timezone strings are fixed offsets of the form "+09:00", "-09" or "+0930".
+    ///
+    /// When feature `chrono-tz` is enabled, additional strings supported by [chrono_tz](https://docs.rs/chrono-tz/latest/chrono_tz/)
+    /// are also allowed, which include [IANA database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
+    /// timezones.
     Timestamp(TimeUnit, Option<Arc<str>>),
     /// A signed 32-bit date representing the elapsed time since UNIX epoch (1970-01-01)
     /// in days.