diff options
| author | Senthil Kumaran <senthil@uthcode.com> | 2016-01-03 00:40:03 -0800 |
|---|---|---|
| committer | Senthil Kumaran <senthil@uthcode.com> | 2016-01-03 00:40:03 -0800 |
| commit | a880800363774848f39e1aa316aa4a44fef9c8fc (patch) | |
| tree | d8b711a5ec54e31cf51278eba748b5d10957c4ed /Doc/library/time.rst | |
| parent | d03d1d45f5d66395f66f165e9b097cd2757ce618 (diff) | |
| download | cpython-git-a880800363774848f39e1aa316aa4a44fef9c8fc.tar.gz | |
Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
values and meaning.
Patch contributed by Andrew Scheller.
Diffstat (limited to 'Doc/library/time.rst')
| -rw-r--r-- | Doc/library/time.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/time.rst b/Doc/library/time.rst index 8d8b7d4c55..0a3d9772b3 100644 --- a/Doc/library/time.rst +++ b/Doc/library/time.rst @@ -550,9 +550,11 @@ The module defines the following functions and data items: +-------+-------------------+---------------------------------+ Note that unlike the C structure, the month value is a range of [1, 12], not - [0, 11]. A ``-1`` argument as the daylight - savings flag, passed to :func:`mktime` will usually result in the correct - daylight savings state to be filled in. + [0, 11]. + + In calls to :func:`mktime`, :attr:`tm_isdst` may be set to 1 when daylight + savings time is in effect, and 0 when it is not. A value of -1 indicates that + this is not known, and will usually result in the correct state being filled in. When a tuple with an incorrect length is passed to a function expecting a :class:`struct_time`, or having elements of the wrong type, a |