From 762c834f69b256990cc0e94b37346d80bcf84ac1 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sun, 4 Jan 2015 17:25:37 +0100 Subject: [PATCH] deprecate model_timezone and view_timezone options --- reference/forms/types/birthday.rst | 4 ++-- reference/forms/types/date.rst | 4 ++-- reference/forms/types/options/model_timezone.rst.inc | 6 ++++++ reference/forms/types/options/view_timezone.rst.inc | 6 ++++++ reference/forms/types/time.rst | 4 ++-- 5 files changed, 18 insertions(+), 6 deletions(-) diff --git a/reference/forms/types/birthday.rst b/reference/forms/types/birthday.rst index 2926a22b369..25e6af62656 100644 --- a/reference/forms/types/birthday.rst +++ b/reference/forms/types/birthday.rst @@ -28,9 +28,9 @@ option defaults to 120 years ago to the current year. | | - `placeholder`_ | | | - `format`_ | | | - `input`_ | -| | - `model_timezone`_ | +| | - `model_timezone`_ (deprecated as of 2.6) | | | - `months`_ | -| | - `view_timezone`_ | +| | - `view_timezone`_ (deprecated as of 2.6) | | | - `widget`_ | | | | | | from the :doc:`form ` type: | diff --git a/reference/forms/types/date.rst b/reference/forms/types/date.rst index 8197e7da328..8131566a810 100644 --- a/reference/forms/types/date.rst +++ b/reference/forms/types/date.rst @@ -24,9 +24,9 @@ day, and year) or three select boxes (see the `widget`_ option). | | - `format`_ | | | - `html5`_ | | | - `input`_ | -| | - `model_timezone`_ | +| | - `model_timezone`_ (deprecated as of 2.6) | | | - `months`_ | -| | - `view_timezone`_ | +| | - `view_timezone`_ (deprecated as of 2.6) | | | - `widget`_ | | | - `years`_ | +----------------------+-----------------------------------------------------------------------------+ diff --git a/reference/forms/types/options/model_timezone.rst.inc b/reference/forms/types/options/model_timezone.rst.inc index f06489ef65f..ebaab7980de 100644 --- a/reference/forms/types/options/model_timezone.rst.inc +++ b/reference/forms/types/options/model_timezone.rst.inc @@ -1,6 +1,12 @@ model_timezone ~~~~~~~~~~~~~~ +.. caution:: + + The ``model_timezone`` option has been deprecated and will be removed + in 3.0. If you pass `DateTime` instances as data to the form type, its + timezone is ignored. + **type**: ``string`` **default**: system default timezone Timezone that the input data is stored in. This must be one of the diff --git a/reference/forms/types/options/view_timezone.rst.inc b/reference/forms/types/options/view_timezone.rst.inc index d2ab65adcbf..51b7775bb10 100644 --- a/reference/forms/types/options/view_timezone.rst.inc +++ b/reference/forms/types/options/view_timezone.rst.inc @@ -1,6 +1,12 @@ view_timezone ~~~~~~~~~~~~~ +.. caution:: + + The ``view_timezone`` option has been deprecated and will be removed + in 3.0. If you pass `DateTime` instances as data to the form type, its + timezone is ignored. + **type**: ``string`` **default**: system default timezone Timezone for how the data should be shown to the user (and therefore also diff --git a/reference/forms/types/time.rst b/reference/forms/types/time.rst index ae95ab4ae94..299b70fd8e1 100644 --- a/reference/forms/types/time.rst +++ b/reference/forms/types/time.rst @@ -20,9 +20,9 @@ as a ``DateTime`` object, a string, a timestamp or an array. | | - `html5`_ | | | - `input`_ | | | - `minutes`_ | -| | - `model_timezone`_ | +| | - `model_timezone`_ (deprecated as of 2.6) | | | - `seconds`_ | -| | - `view_timezone`_ | +| | - `view_timezone`_ (deprecated as of 2.6) | | | - `widget`_ | | | - `with_minutes`_ | | | - `with_seconds`_ |