Skip to content

DOC: Clarify documentation of 'ambiguous' parameter #23408

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 10 commits into from
Nov 4, 2018
Merged

DOC: Clarify documentation of 'ambiguous' parameter #23408

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f25ed6b
Add documentation line with example for the ambiguous parameter of tz…
bartaelterman Oct 29, 2018
551e149
Updating 'ambiguous'-param doc + update it on Timestamp, DatetimeInde…
bartaelterman Oct 30, 2018
4274d08
Add some examples for the ambiguous parameter for localizing timestamps
bartaelterman Oct 30, 2018
b33e370
Make docstring of NaT tz_localize equal to Timestamp tz_localize
bartaelterman Oct 31, 2018
a7b27b6
show example for Series.tz_localize (not dt.tz_localize)
bartaelterman Oct 31, 2018
efeeab7
add ambiguous docstring to arrays/datetimes
bartaelterman Oct 31, 2018
7e60b3d
fix bug in the docstring
bartaelterman Oct 31, 2018
d18e80f
chop off long lines in docstring
bartaelterman Oct 31, 2018
4a9ad4b
chop long lines in docstring
bartaelterman Oct 31, 2018
b1026c3
chop long line in docstring
bartaelterman Oct 31, 2018
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
7 changes: 7 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8623,6 +8623,13 @@ def tz_localize(self, tz, axis=0, level=None, copy=True,
copy : boolean, default True
Also make a copy of the underlying data
ambiguous : 'infer', bool-ndarray, 'NaT', default 'raise'
When clocks moved backward due to DST, ambiguous times may arise.
E.g. in Central European Time (UTC+01), when going from 03:00 DST
to 02:00 non-DST, the naive time 02:30:00 occurs both at
00:30:00 UTC and at 01:30:00 UTC. In such a situation, the
`ambiguous` parameter can be used to correctly localize these
times.

- 'infer' will attempt to infer fall dst-transition hours based on
order
- bool-ndarray where True signifies a DST time, False designates
Expand Down