Fixed #27921 -- Clarified usage of make_aware() with is_dst argument.
This commit is contained in:
parent
2fd610eb30
commit
c2678e4975
|
@ -945,11 +945,14 @@ appropriate entities.
|
||||||
post-transition respectively.
|
post-transition respectively.
|
||||||
|
|
||||||
The ``pytz.NonExistentTimeError`` exception is raised if you try to make
|
The ``pytz.NonExistentTimeError`` exception is raised if you try to make
|
||||||
``value`` aware during a DST transition such that the time never occurred
|
``value`` aware during a DST transition such that the time never occurred.
|
||||||
(when entering into DST). Setting ``is_dst`` to ``True`` or ``False`` will
|
For example, if the 2:00 hour is skipped during a DST transition, trying to
|
||||||
avoid the exception by moving the hour backwards or forwards by 1
|
make 2:30 aware in that time zone will raise an exception. To avoid that
|
||||||
respectively. For example, ``is_dst=True`` would change a nonexistent
|
you can use ``is_dst`` to specify how ``make_aware()`` should interpret
|
||||||
time of 2:30 to 1:30 and ``is_dst=False`` would change the time to 3:30.
|
such a nonexistent time. If ``is_dst=True`` then the above time would be
|
||||||
|
interpreted as 2:30 DST time (equivalent to 1:30 local time). Conversely,
|
||||||
|
if ``is_dst=False`` the time would be interpreted as 2:30 standard time
|
||||||
|
(equivalent to 3:30 local time).
|
||||||
|
|
||||||
.. function:: make_naive(value, timezone=None)
|
.. function:: make_naive(value, timezone=None)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue