From 523eac9b9a9f276b248fed1b3ac489ccf9fe9c1a Mon Sep 17 00:00:00 2001 From: "Francis T. O'Donovan" Date: Mon, 7 Dec 2015 09:25:04 -0500 Subject: [PATCH] DOC: Add examples for pandas.tseries.timedeltas Copied examples from pandas-docs/stable/timedeltas.html. --- pandas/tseries/timedeltas.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/pandas/tseries/timedeltas.py b/pandas/tseries/timedeltas.py index 11200bb2540cd..a880f29989f57 100644 --- a/pandas/tseries/timedeltas.py +++ b/pandas/tseries/timedeltas.py @@ -32,6 +32,28 @@ def to_timedelta(arg, unit='ns', box=True, errors='raise', coerce=None): Returns ------- ret : timedelta64/arrays of timedelta64 if parsing succeeded + + Examples + -------- + + Parsing a single string to a Timedelta: + + >>> pd.to_timedelta('1 days 06:05:01.00003') + Timedelta('1 days 06:05:01.000030') + >>> pd.to_timedelta('15.5us') + Timedelta('0 days 00:00:00.000015') + + Parsing a list or array of strings: + + >>> pd.to_timedelta(['1 days 06:05:01.00003', '15.5us', 'nan']) + TimedeltaIndex(['1 days 06:05:01.000030', '0 days 00:00:00.000015', NaT], dtype='timedelta64[ns]', freq=None) + + Converting numbers by specifying the `unit` keyword argument: + + >>> pd.to_timedelta(np.arange(5), unit='s') + TimedeltaIndex(['00:00:00', '00:00:01', '00:00:02', '00:00:03', '00:00:04'], dtype='timedelta64[ns]', freq=None) + >>> pd.to_timedelta(np.arange(5), unit='d') + TimedeltaIndex(['0 days', '1 days', '2 days', '3 days', '4 days'], dtype='timedelta64[ns]', freq=None) """ unit = _validate_timedelta_unit(unit)