Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[1.5.x] Fixed #19518 -- Documented the deprecation of localflavor.

Also moved the contrib deprecations at the top of their section and made
minor markup fixes.

Backport of 4500d35 from master.
  • Loading branch information...
commit 0c79e5e347e3c5d3f942d4338bb5476f0277cd21 1 parent 4f67ab6
Aymeric Augustin authored December 26, 2012
14  docs/internals/deprecation.txt
@@ -14,7 +14,7 @@ See the :doc:`Django 1.2 release notes</releases/1.2>` for more details on
14 14
 these changes.
15 15
 
16 16
 * ``CsrfResponseMiddleware`` and ``CsrfMiddleware`` will be removed.  Use
17  
-  the {% csrf_token %} template tag inside forms to enable CSRF
  17
+  the ``{% csrf_token %}`` template tag inside forms to enable CSRF
18 18
   protection. ``CsrfViewMiddleware`` remains and is enabled by default.
19 19
 
20 20
 * The old imports for CSRF functionality (``django.contrib.csrf.*``),
@@ -200,6 +200,14 @@ these changes.
200 200
 See the :doc:`Django 1.4 release notes</releases/1.4>` for more details on
201 201
 these changes.
202 202
 
  203
+* ``django.contrib.databrowse`` will be removed.
  204
+
  205
+* ``django.contrib.localflavor`` will be removed following an accelerated
  206
+  deprecation.
  207
+
  208
+* ``django.contrib.markup`` will be removed following an accelerated
  209
+  deprecation.
  210
+
203 211
 * The compatibility modules ``django.utils.copycompat`` and
204 212
   ``django.utils.hashcompat`` as well as the functions
205 213
   ``django.utils.itercompat.all`` and ``django.utils.itercompat.any`` will
@@ -251,8 +259,6 @@ these changes.
251 259
   :data:`~django.conf.urls.handler500`, are now available through
252 260
   :mod:`django.conf.urls` .
253 261
 
254  
-* The Databrowse contrib module will be removed.
255  
-
256 262
 * The functions :func:`~django.core.management.setup_environ` and
257 263
   :func:`~django.core.management.execute_manager` will be removed from
258 264
   :mod:`django.core.management`. This also means that the old (pre-1.4)
@@ -265,8 +271,6 @@ these changes.
265 271
   in 1.4. The backward compatibility will be removed --
266 272
   ``HttpRequest.raw_post_data`` will no longer work.
267 273
 
268  
-* ``django.contrib.markup`` will be removed following an accelerated
269  
-  deprecation.
270 274
 
271 275
 * The value for the ``post_url_continue`` parameter in
272 276
   ``ModelAdmin.response_add()`` will have to be either ``None`` (to redirect
6  docs/ref/contrib/localflavor.txt
@@ -37,6 +37,8 @@ file.
37 37
 
38 38
 .. _ISO 3166 country code: http://www.iso.org/iso/country_codes.htm
39 39
 
  40
+.. _localflavor-how-to-migrate:
  41
+
40 42
 How to migrate
41 43
 ==============
42 44
 
@@ -60,6 +62,8 @@ The code in the new packages is the same (it was copied directly from Django),
60 62
 so you don't have to worry about backwards compatibility in terms of
61 63
 functionality. Only the imports have changed.
62 64
 
  65
+.. _localflavor-deprecation-policy:
  66
+
63 67
 Deprecation policy
64 68
 ==================
65 69
 
@@ -70,6 +74,8 @@ change it as soon as possible.
70 74
 In Django 1.6, importing from ``django.contrib.localflavor`` will no longer
71 75
 work.
72 76
 
  77
+.. _localflavor-packages:
  78
+
73 79
 Supported countries
74 80
 ===================
75 81
 
31  docs/releases/1.5.txt
@@ -634,7 +634,26 @@ Miscellaneous
634 634
 Features deprecated in 1.5
635 635
 ==========================
636 636
 
637  
-.. _simplejson-deprecation:
  637
+``django.contrib.localflavor``
  638
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  639
+
  640
+The localflavor contrib app has been split into separate packages.
  641
+``django.contrib.localflavor`` itself will be removed in Django 1.6, after an
  642
+:ref:`accelerated deprecation <localflavor-deprecation-policy>`. The docs
  643
+provide :ref:`migration instructions <localflavor-how-to-migrate>`.
  644
+
  645
+The new packages are available :ref:`on Github <localflavor-packages>`. The
  646
+core team cannot efficiently maintain these packages in the long term — it
  647
+spans just a dozen countries at this time; similar to translations, maintenance
  648
+will be handed over to interested members of the community.
  649
+
  650
+``django.contrib.markup``
  651
+~~~~~~~~~~~~~~~~~~~~~~~~~
  652
+
  653
+The markup contrib module has been deprecated and will follow an accelerated
  654
+deprecation schedule. Direct use of python markup libraries or 3rd party tag
  655
+libraries is preferred to Django maintaining this functionality in the
  656
+framework.
638 657
 
639 658
 :setting:`AUTH_PROFILE_MODULE`
640 659
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -660,6 +679,8 @@ to :class:`~django.http.HttpResponse`. If you rely on this behavior, switch to
660 679
 In Django 1.7 and above, the iterator will be consumed immediately by
661 680
 :class:`~django.http.HttpResponse`.
662 681
 
  682
+.. _simplejson-deprecation:
  683
+
663 684
 ``django.utils.simplejson``
664 685
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
665 686
 
@@ -687,14 +708,6 @@ Define a ``__str__`` method and apply the
687 708
 The :func:`~django.utils.itercompat.product` function has been deprecated. Use
688 709
 the built-in :func:`itertools.product` instead.
689 710
 
690  
-``django.utils.markup``
691  
-~~~~~~~~~~~~~~~~~~~~~~~
692  
-
693  
-The markup contrib module has been deprecated and will follow an accelerated
694  
-deprecation schedule. Direct use of python markup libraries or 3rd party tag
695  
-libraries is preferred to Django maintaining this functionality in the
696  
-framework.
697  
-
698 711
 ``cleanup`` management command
699 712
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
700 713
 

0 notes on commit 0c79e5e

Please sign in to comment.
Something went wrong with that request. Please try again.