summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJon Dufresne <jon.dufresne@gmail.com>2016-08-31 17:19:33 -0700
committerGitHub <noreply@github.com>2016-08-31 17:19:33 -0700
commitff1e7b4eb43737bf2752197036663cee58922317 (patch)
tree3ef2013de20c59e91dbe2532383ea62bb4763f20 /docs
parentd8ef5b0e6501692b8b767ebccddc936f496d77e8 (diff)
Fixed #25181 -- Added localdate() function to get date in a different time zone.
Thanks Konrad Świat for the original patch.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/utils.txt20
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 893ecb5792..00ac7970d7 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -974,14 +974,32 @@ appropriate entities.
``override`` is also usable as a function decorator.
-.. function:: localtime(value, timezone=None)
+.. function:: localtime(value=None, timezone=None)
Converts an aware :class:`~datetime.datetime` to a different time zone,
by default the :ref:`current time zone <default-current-time-zone>`.
+ When ``value`` is omitted, it defaults to :func:`now`.
+
This function doesn't work on naive datetimes; use :func:`make_aware`
instead.
+ .. versionchanged:: 1.11
+
+ In older versions, ``value`` is a required argument.
+
+.. function:: localdate(value=None, timezone=None)
+
+ .. versionadded:: 1.11
+
+ Uses :func:`localtime` to convert an aware :class:`~datetime.datetime` to a
+ :meth:`~datetime.datetime.date` in a different time zone, by default the
+ :ref:`current time zone <default-current-time-zone>`.
+
+ When ``value`` is omitted, it defaults to :func:`now`.
+
+ This function doesn't work on naive datetimes.
+
.. function:: now()
Returns a :class:`~datetime.datetime` that represents the