DOC: update the DatetimeIndex.tz_convert(tz) docstring #20096
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1904,24 +1904,48 @@ def delete(self, loc): | |
|
|
||
| def tz_convert(self, tz): | ||
| """ | ||
| Convert tz-aware DatetimeIndex from one | ||
| time zone to another. | ||
|
|
||
| When using DatetimeIndex providing with timezone this method | ||
|
There was a problem hiding this comment. This is a cumbersome sentence and is pretty duplicative of the above, I would remove it. There was a problem hiding this comment. I regret the auto typing mistake, I wanted to convey that i will surely be doing it as per recommended by you. There was a problem hiding this comment. @hammadmashkoor no problem. thanks for the PR! There was a problem hiding this comment. I don't think this extended summary is needed at all as its duplicated of the Summary. |
||
| converts tz-aware DatetimeIndex using pytz/dateutil. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| tz : string, pytz.timezone, dateutil.tz.tzfile or None | ||
| Time zone for time.Corresponding timestamps would be converted | ||
|
There was a problem hiding this comment. You seemed to have removed a space between the two words, which I suppose was a mistake. |
||
| to time zone of the TimeSeries. | ||
|
There was a problem hiding this comment. TimeSeries -> DatetimeIndex |
||
| None will remove timezone holding UTC time. | ||
|
|
||
| Returns | ||
| ------- | ||
| normalized : DatetimeIndex | ||
|
|
||
| Raises | ||
| ------- | ||
|
There was a problem hiding this comment. This change is not needed (the line under the title can be exactly as long as the title itself) |
||
| TypeError | ||
| If DatetimeIndex is tz-naive. | ||
|
|
||
| See Also | ||
| -------- | ||
| tz_localize : Localize tz-naive DatetimeIndex to given time zone | ||
| (using pytz/dateutil),or remove timezone from tz-aware | ||
| DatetimeIndex. | ||
|
|
||
| Examples | ||
| -------- | ||
| >>> datetime=pd.Series(pd.date_range('20180301',periods=3)) | ||
| >>> datetime | ||
| 0 2018-03-01 | ||
| 1 2018-03-02 | ||
| 2 2018-03-03 | ||
| dtype: datetime64[ns] | ||
|
|
||
| >>> datetime.dt.tz_localize('UTC').dt.tz_convert('US/Eastern') | ||
| 0 2018-02-28 19:00:00-05:00 | ||
| 1 2018-03-01 19:00:00-05:00 | ||
| 2 2018-03-02 19:00:00-05:00 | ||
| dtype: datetime64[ns, US/Eastern] | ||
|
There was a problem hiding this comment. Can you also add an example that uses |
||
| """ | ||
| tz = timezones.maybe_get_tz(tz) | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you put this on one line? (I think it should fit within 80 chars)