From 782f904375c145173f63c125a5fe1af10c189b7a Mon Sep 17 00:00:00 2001 From: Kevin Cox Date: Fri, 29 Jul 2022 09:40:11 -0400 Subject: [PATCH] Clarify docs for `DateTime::with_timezone` The previous docs don't really make sense, why am I calling a method if it doesn't change the value? The new wording clarifies what is held the same and what changes. --- src/datetime/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/datetime/mod.rs b/src/datetime/mod.rs index 28cb16d23a..1e0050bd19 100644 --- a/src/datetime/mod.rs +++ b/src/datetime/mod.rs @@ -313,7 +313,7 @@ impl DateTime { } /// Changes the associated time zone. - /// This does not change the actual `DateTime` (but will change the string representation). + /// The returned `DateTime` references the same instant of time from the perspective of the provided time zone. #[inline] pub fn with_timezone(&self, tz: &Tz2) -> DateTime { tz.from_utc_datetime(&self.datetime)