Skip to content

DOC: clarify (un)aware logic in tz_localize() docstring #40940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2021
Merged

DOC: clarify (un)aware logic in tz_localize() docstring #40940

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6923c8
DOC: fix tz (un)aware logic in tz_localize() docstring
jgehrcke Apr 14, 2021
4ffb6d1
DOC: fix tz (un)aware logic in tz_localize() docstring
jgehrcke Apr 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions pandas/core/arrays/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -857,8 +857,9 @@ def tz_localize(self, tz, ambiguous="raise", nonexistent="raise") -> DatetimeArr
This method takes a time zone (tz) naive Datetime Array/Index object
and makes this time zone aware. It does not move the time to another
time zone.
Time zone localization helps to switch from time zone aware to time
zone unaware objects.

This method can also be used to do the inverse -- to create a time
zone unaware object from an aware object. To that end, pass `tz=None`.

Parameters
----------
Expand Down