Skip to content

Commit

Permalink
Fixed #19518 -- Documented the deprecation of localflavor.
Browse files Browse the repository at this point in the history
Also moved the contrib deprecations at the top of their section and made
minor markup fixes.
  • Loading branch information
aaugustin committed Dec 26, 2012
1 parent 0907d3c commit 4500d35
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 14 deletions.
14 changes: 9 additions & 5 deletions docs/internals/deprecation.txt
Expand Up @@ -14,7 +14,7 @@ See the :doc:`Django 1.2 release notes</releases/1.2>` for more details on
these changes.

* ``CsrfResponseMiddleware`` and ``CsrfMiddleware`` will be removed. Use
the {% csrf_token %} template tag inside forms to enable CSRF
the ``{% csrf_token %}`` template tag inside forms to enable CSRF
protection. ``CsrfViewMiddleware`` remains and is enabled by default.

* The old imports for CSRF functionality (``django.contrib.csrf.*``),
Expand Down Expand Up @@ -200,6 +200,14 @@ these changes.
See the :doc:`Django 1.4 release notes</releases/1.4>` for more details on
these changes.

* ``django.contrib.databrowse`` will be removed.

* ``django.contrib.localflavor`` will be removed following an accelerated
deprecation.

* ``django.contrib.markup`` will be removed following an accelerated
deprecation.

* The compatibility modules ``django.utils.copycompat`` and
``django.utils.hashcompat`` as well as the functions
``django.utils.itercompat.all`` and ``django.utils.itercompat.any`` will
Expand Down Expand Up @@ -251,8 +259,6 @@ these changes.
:data:`~django.conf.urls.handler500`, are now available through
:mod:`django.conf.urls` .

* The Databrowse contrib module will be removed.

* The functions :func:`~django.core.management.setup_environ` and
:func:`~django.core.management.execute_manager` will be removed from
:mod:`django.core.management`. This also means that the old (pre-1.4)
Expand All @@ -265,8 +271,6 @@ these changes.
in 1.4. The backward compatibility will be removed --
``HttpRequest.raw_post_data`` will no longer work.

* ``django.contrib.markup`` will be removed following an accelerated
deprecation.

* The value for the ``post_url_continue`` parameter in
``ModelAdmin.response_add()`` will have to be either ``None`` (to redirect
Expand Down
6 changes: 6 additions & 0 deletions docs/ref/contrib/localflavor.txt
Expand Up @@ -37,6 +37,8 @@ file.

.. _ISO 3166 country code: http://www.iso.org/iso/country_codes.htm

.. _localflavor-how-to-migrate:

How to migrate
==============

Expand All @@ -60,6 +62,8 @@ The code in the new packages is the same (it was copied directly from Django),
so you don't have to worry about backwards compatibility in terms of
functionality. Only the imports have changed.

.. _localflavor-deprecation-policy:

Deprecation policy
==================

Expand All @@ -70,6 +74,8 @@ change it as soon as possible.
In Django 1.6, importing from ``django.contrib.localflavor`` will no longer
work.

.. _localflavor-packages:

Supported countries
===================

Expand Down
31 changes: 22 additions & 9 deletions docs/releases/1.5.txt
Expand Up @@ -634,7 +634,26 @@ Miscellaneous
Features deprecated in 1.5
==========================

.. _simplejson-deprecation:
``django.contrib.localflavor``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The localflavor contrib app has been split into separate packages.
``django.contrib.localflavor`` itself will be removed in Django 1.6, after an
:ref:`accelerated deprecation <localflavor-deprecation-policy>`. The docs
provide :ref:`migration instructions <localflavor-how-to-migrate>`.

The new packages are available :ref:`on Github <localflavor-packages>`. The
core team cannot efficiently maintain these packages in the long term — it
spans just a dozen countries at this time; similar to translations, maintenance
will be handed over to interested members of the community.

``django.contrib.markup``
~~~~~~~~~~~~~~~~~~~~~~~~~

The markup contrib module has been deprecated and will follow an accelerated
deprecation schedule. Direct use of python markup libraries or 3rd party tag
libraries is preferred to Django maintaining this functionality in the
framework.

:setting:`AUTH_PROFILE_MODULE`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -660,6 +679,8 @@ to :class:`~django.http.HttpResponse`. If you rely on this behavior, switch to
In Django 1.7 and above, the iterator will be consumed immediately by
:class:`~django.http.HttpResponse`.

.. _simplejson-deprecation:

``django.utils.simplejson``
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -687,14 +708,6 @@ Define a ``__str__`` method and apply the
The :func:`~django.utils.itercompat.product` function has been deprecated. Use
the built-in :func:`itertools.product` instead.

``django.utils.markup``
~~~~~~~~~~~~~~~~~~~~~~~

The markup contrib module has been deprecated and will follow an accelerated
deprecation schedule. Direct use of python markup libraries or 3rd party tag
libraries is preferred to Django maintaining this functionality in the
framework.

``cleanup`` management command
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 4500d35

Please sign in to comment.