[Python-checkins] cpython (3.4): Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid

[senthil.kumaran]

https://hg.python.org/cpython/rev/fae779a811ec
changeset:   99762:fae779a811ec
branch:      3.4
parent:      99755:521a402ae177
user:        Senthil Kumaran <senthil at uthcode.com>
date:        Sun Jan 03 00:40:03 2016 -0800
summary:
  Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
values and meaning.

Patch contributed by Andrew Scheller.

files:
  Doc/library/time.rst |  8 +++++---
  1 files changed, 5 insertions(+), 3 deletions(-)


diff --git a/Doc/library/time.rst b/Doc/library/time.rst
--- a/Doc/library/time.rst
+++ b/Doc/library/time.rst
@@ -550,9 +550,11 @@
    +-------+-------------------+---------------------------------+
 
    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

-- 
Repository URL: https://hg.python.org/cpython