Skip to content

DOC: update the DatetimeIndex.tz_convert(tz) docstring #20096

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 15 commits into from
Mar 13, 2018
Merged

DOC: update the DatetimeIndex.tz_convert(tz) docstring #20096

Changes from 10 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
b062d66
Added Docstring for DatetimeIndex.tz_convert(tz)
invalid-email-address Mar 9, 2018
82c6546
Merge remote-tracking branch 'upstream/master' into docstring_Datetim…
hammadmashkoor Mar 10, 2018
d16d9ef
Doc:added for TimedateIndex.tz_convert(tz)
hammadmashkoor Mar 10, 2018
2179e2d
Merge remote-tracking branch 'upstream/master' into docstring_Datetim…
hammadmashkoor Mar 10, 2018
74ba82a
Update Docstring
hammadmashkoor Mar 10, 2018
4f7a570
Updated on recent comments
hammadmashkoor Mar 10, 2018
7a003de
Updated under comments
hammadmashkoor Mar 10, 2018
fac2544
Updated under recommendations
hammadmashkoor Mar 10, 2018
236e00b
Updated under recommendations
hammadmashkoor Mar 10, 2018
1b56342
Updated under recommendations
hammadmashkoor Mar 10, 2018
f8e4024
Updated under recommendations
hammadmashkoor Mar 10, 2018
c136136
Merge remote-tracking branch 'upstream/master' into docstring_Datetim…
hammadmashkoor Mar 11, 2018
3d9b5b5
Merge remote-tracking branch 'upstream/master' into docstring_Datetim…
hammadmashkoor Mar 13, 2018
1f0adfc
Updated
hammadmashkoor Mar 13, 2018
ff00665
Formatting on tz
TomAugspurger Mar 13, 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
53 changes: 49 additions & 4 deletions pandas/core/indexes/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1904,14 +1904,17 @@ def delete(self, loc):

def tz_convert(self, tz):
"""
Convert tz-aware DatetimeIndex from one time zone to another (using
pytz/dateutil)
Convert tz-aware DatetimeIndex from one time zone to another.

When using DatetimeIndex providing with timezone this method
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a cumbersome sentence and is pretty duplicative of the above, I would remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I regret the auto typing mistake, I wanted to convey that i will surely be doing it as per recommended by you.
Please pardon my Indian English.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hammadmashkoor no problem. thanks for the PR!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this extended summary is needed at all as its duplicated of the Summary.

converts tz(timezone)-aware DatetimeIndex from one timezone
to another.

Parameters
----------
tz : string, pytz.timezone, dateutil.tz.tzfile or None
Time zone for time. Corresponding timestamps would be converted to
time zone of the TimeSeries.
Time zone for time. Corresponding timestamps would be converted
to time zone of the DatetimeIndex.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to time zone of the DatetimeIndex -> to this time zone.

None will remove timezone holding UTC time.

Returns
Expand All @@ -1922,6 +1925,48 @@ def tz_convert(self, tz):
------
TypeError
If DatetimeIndex is tz-naive.

See Also
--------
tz_localize : Localize tz-naive DatetimeIndex to given time zone,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to a given time zone

or remove timezone from a tz-aware DatetimeIndex

or remove timezone from tz-aware DatetimeIndex.

Examples
--------
With the `tz` parameter, we can change the DatetimeIndex
to other time zones:

>>> dti = pd.DatetimeIndex(start='2014-08-01 09:00',
... freq='H', periods=3)

>>> dti
DatetimeIndex(['2014-08-01 09:00:00',
'2014-08-01 10:00:00',
'2014-08-01 11:00:00'],
dtype='datetime64[ns]', freq='H')

>>> dti.tz_localize('Europe/Berlin').tz_convert('US/Eastern')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't use tz_convert here, this is about the tz_localize doc-string

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

DatetimeIndex(['2014-08-01 03:00:00-04:00',
'2014-08-01 04:00:00-04:00',
'2014-08-01 05:00:00-04:00'],
dtype='datetime64[ns, US/Eastern]', freq='H')

With the `None` parameter, we can remove the timezone:

>>> dti = pd.DatetimeIndex(start='2014-08-01 09:00',freq='H',
... periods=3, tz='Europe/Berlin')

>>> dti
DatetimeIndex(['2014-08-01 09:00:00+02:00',
'2014-08-01 10:00:00+02:00',
'2014-08-01 11:00:00+02:00'],
dtype='datetime64[ns, Europe/Berlin]', freq='H')

>>> dti.tz_convert(None)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes this is correct

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks..

DatetimeIndex(['2014-08-01 07:00:00',
'2014-08-01 08:00:00',
'2014-08-01 09:00:00'],
dtype='datetime64[ns]', freq='H')
"""
tz = timezones.maybe_get_tz(tz)

Expand Down