docs: add note about conversion as if from utc in convert_time_zone (#…

…1320)
narwhals-dev · Nov 4, 2024 · 18d8bda · 18d8bda
1 parent 5c43561
commit 18d8bda
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/narwhals/expr.py b/narwhals/expr.py
@@ -3917,6 +3917,9 @@ def convert_time_zone(self: Self, time_zone: str) -> T:
         """
         Convert to a new time zone.
 
+        If converting from a time-zone-naive column, then conversion happens
+        as if converting from UTC.
+
         Arguments:
             time_zone: Target time zone.
 

diff --git a/narwhals/series.py b/narwhals/series.py
@@ -3988,6 +3988,9 @@ def convert_time_zone(self: Self, time_zone: str) -> T:
         """
         Convert time zone.
 
+        If converting from a time-zone-naive column, then conversion happens
+        as if converting from UTC.
+
         Arguments:
             time_zone: Target time zone.