From 1a5a28fc7b9dfdd732a7b732592a5e9181a16dce Mon Sep 17 00:00:00 2001 From: dare Date: Sat, 8 Jan 2022 14:52:08 +0100 Subject: [PATCH] Added note in docs for giving the developer the option of choosing between both parameters and kwargs. Exampled included --- pandas/_libs/tslibs/timedeltas.pyx | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/pandas/_libs/tslibs/timedeltas.pyx b/pandas/_libs/tslibs/timedeltas.pyx index f536c8dd76f0d..1cad2b461d576 100644 --- a/pandas/_libs/tslibs/timedeltas.pyx +++ b/pandas/_libs/tslibs/timedeltas.pyx @@ -1246,10 +1246,29 @@ class Timedelta(_Timedelta): Notes ----- + The constructor may take in either both values of value and unit or + kwargs as above. Either one of them must be used during initialization + The ``.value`` attribute is always in ns. If the precision is higher than nanoseconds, the precision of the duration is truncated to nanoseconds. + + Examples + -------- + Here we initialize Timedelta object with both value and unit + + >>> td = pd.Timedelta(1, "d") + >>> td + Timedelta('1 days 00:00:00') + + Here we initialize the Timedelta object with kwargs + + >>> td2 = pd.Timedelta(days=1) + >>> td2 + Timedelta('1 days 00:00:00') + + We see that either way we get the same result """ def __new__(cls, object value=_no_input, unit=None, **kwargs):