diff options
author | Cheryl Sabella <cheryl.sabella@gmail.com> | 2017-10-11 13:29:14 (GMT) |
---|---|---|
committer | Berker Peksag <berker.peksag@gmail.com> | 2017-10-11 13:29:14 (GMT) |
commit | 703ff381ffa946c23e7e25b0ae93a636a2607a40 (patch) | |
tree | 537b02be8672722f1f2b9606bf925e94e959305a /Modules | |
parent | eeb5ffd54e56dd89a99c74eb512c36d62649cfec (diff) | |
download | cpython-703ff381ffa946c23e7e25b0ae93a636a2607a40.zip cpython-703ff381ffa946c23e7e25b0ae93a636a2607a40.tar.gz cpython-703ff381ffa946c23e7e25b0ae93a636a2607a40.tar.bz2 |
bpo-28157: Improvements for the time module documentation (GH-928)
* Separated functions and constants descriptions in sections.
* Added a note about the limitations of timezone constants.
* Removed redundant lists from the module docstring.
Diffstat (limited to 'Modules')
-rw-r--r-- | Modules/timemodule.c | 23 |
1 files changed, 1 insertions, 22 deletions
diff --git a/Modules/timemodule.c b/Modules/timemodule.c index 31050fb..2c0a8d6 100644 --- a/Modules/timemodule.c +++ b/Modules/timemodule.c @@ -1342,28 +1342,7 @@ The tuple items are:\n\ DST (Daylight Savings Time) flag (-1, 0 or 1)\n\ If the DST flag is 0, the time is given in the regular time zone;\n\ if it is 1, the time is given in the DST time zone;\n\ -if it is -1, mktime() should guess based on the date and time.\n\ -\n\ -Variables:\n\ -\n\ -timezone -- difference in seconds between UTC and local standard time\n\ -altzone -- difference in seconds between UTC and local DST time\n\ -daylight -- whether local time should reflect DST\n\ -tzname -- tuple of (standard time zone name, DST time zone name)\n\ -\n\ -Functions:\n\ -\n\ -time() -- return current time in seconds since the Epoch as a float\n\ -clock() -- return CPU time since process start as a float\n\ -sleep() -- delay for a number of seconds given as a float\n\ -gmtime() -- convert seconds since Epoch to UTC tuple\n\ -localtime() -- convert seconds since Epoch to local time tuple\n\ -asctime() -- convert time tuple to string\n\ -ctime() -- convert time in seconds to string\n\ -mktime() -- convert local time tuple to seconds since Epoch\n\ -strftime() -- convert time tuple to string according to format specification\n\ -strptime() -- parse string to time tuple according to format specification\n\ -tzset() -- change the local timezone"); +if it is -1, mktime() should guess based on the date and time.\n"); |