summaryrefslogtreecommitdiffstats
path: root/Modules/_datetimemodule.c
diff options
context:
space:
mode:
authorChris Barker <Chris.Barker@noaa.gov>2018-10-19 22:43:24 (GMT)
committerVictor Stinner <vstinner@redhat.com>2018-10-19 22:43:24 (GMT)
commitd6a61f232619f8a8e6efacc3da5a02abaf25f090 (patch)
treefae07a33214a84ca8690a4137e1acffab682ea40 /Modules/_datetimemodule.c
parent8deab9672554edaf58f91e238cc899463d53f6ea (diff)
downloadcpython-d6a61f232619f8a8e6efacc3da5a02abaf25f090.zip
cpython-d6a61f232619f8a8e6efacc3da5a02abaf25f090.tar.gz
cpython-d6a61f232619f8a8e6efacc3da5a02abaf25f090.tar.bz2
Elaborate datetime.timedelta docstring (GH-7458)
Diffstat (limited to 'Modules/_datetimemodule.c')
-rw-r--r--Modules/_datetimemodule.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/Modules/_datetimemodule.c b/Modules/_datetimemodule.c
index b7c59f1..cdfa235 100644
--- a/Modules/_datetimemodule.c
+++ b/Modules/_datetimemodule.c
@@ -2641,7 +2641,11 @@ static PyMethodDef delta_methods[] = {
};
static const char delta_doc[] =
-PyDoc_STR("Difference between two datetime values.");
+PyDoc_STR("Difference between two datetime values.\n\n"
+ "timedelta(days=0, seconds=0, microseconds=0, milliseconds=0, "
+ "minutes=0, hours=0, weeks=0)\n\n"
+ "All arguments are optional and default to 0.\n"
+ "Arguments may be integers or floats, and may be positive or negative.");
static PyNumberMethods delta_as_number = {
delta_add, /* nb_add */