From 8e389227bfaf608d4690fde35305e6024f009dac Mon Sep 17 00:00:00 2001 From: Chalmer Lowe Date: Sat, 19 May 2018 10:00:35 -1000 Subject: [PATCH 1/2] DOC: Improve the docstring of Timedelta.delta redux --- pandas/_libs/tslibs/timedeltas.pyx | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/pandas/_libs/tslibs/timedeltas.pyx b/pandas/_libs/tslibs/timedeltas.pyx index f7bb6c1dbb304..bb6b2cd879462 100644 --- a/pandas/_libs/tslibs/timedeltas.pyx +++ b/pandas/_libs/tslibs/timedeltas.pyx @@ -760,7 +760,32 @@ cdef class _Timedelta(timedelta): @property def delta(self): - """ return out delta in ns (for internal compat) """ + """ + Return the timedelta in nanoseconds (ns), for internal compatibility. + + Returns + ------- + int + Timedelta in nanoseconds. + + Examples + -------- + >>> td = pd.Timedelta('1 days 42 ns') + >>> td.delta + 86400000000042 + + >>> td = pd.Timedelta('3 s') + >>> td.delta + 3000000000 + + >>> td = pd.Timedelta('3 ms 5 us') + >>> td.delta + 3005000 + + >>> td = pd.Timedelta(42, unit='ns') + >>> td.delta + 42 + """ return self.value @property From e9348b664a1411e207aedb8336b6549e2b2e5adf Mon Sep 17 00:00:00 2001 From: Chalmer Lowe Date: Sat, 19 May 2018 11:30:22 -1000 Subject: [PATCH 2/2] DOC: removed whitespace from Timedelta.delta --- pandas/_libs/tslibs/timedeltas.pyx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/_libs/tslibs/timedeltas.pyx b/pandas/_libs/tslibs/timedeltas.pyx index bb6b2cd879462..3f0b4db87e5ed 100644 --- a/pandas/_libs/tslibs/timedeltas.pyx +++ b/pandas/_libs/tslibs/timedeltas.pyx @@ -784,7 +784,7 @@ cdef class _Timedelta(timedelta): >>> td = pd.Timedelta(42, unit='ns') >>> td.delta - 42 + 42 """ return self.value