Skip to content

Commit 9a167aa

Browse files
jgehrckeyeshsurya
authored andcommitted
DOC: clarify (un)aware logic in tz_localize() docstring (pandas-dev#40940)
1 parent 344d52a commit 9a167aa

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

pandas/core/arrays/datetimes.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -855,8 +855,9 @@ def tz_localize(self, tz, ambiguous="raise", nonexistent="raise") -> DatetimeArr
855855
This method takes a time zone (tz) naive Datetime Array/Index object
856856
and makes this time zone aware. It does not move the time to another
857857
time zone.
858-
Time zone localization helps to switch from time zone aware to time
859-
zone unaware objects.
858+
859+
This method can also be used to do the inverse -- to create a time
860+
zone unaware object from an aware object. To that end, pass `tz=None`.
860861
861862
Parameters
862863
----------

0 commit comments

Comments
 (0)