diff options
| author | Aymeric Augustin <aymeric.augustin@m4x.org> | 2012-12-24 23:10:40 +0100 |
|---|---|---|
| committer | Aymeric Augustin <aymeric.augustin@m4x.org> | 2012-12-29 21:59:06 +0100 |
| commit | f27a4ee3270bd57299ce02d622978ac4d839137e (patch) | |
| tree | 81eeff497392808e3468de9cb864f31b0a6de931 /docs/misc | |
| parent | b2d20e982627b8c5f21fe68c5531b40ee20f1cfc (diff) | |
Removed django.contrib.localflavor.
Each localflavor lives on as a separate app.
Diffstat (limited to 'docs/misc')
| -rw-r--r-- | docs/misc/api-stability.txt | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/misc/api-stability.txt b/docs/misc/api-stability.txt index 70e6006575..8ae3c716df 100644 --- a/docs/misc/api-stability.txt +++ b/docs/misc/api-stability.txt @@ -149,56 +149,3 @@ Certain APIs are explicitly marked as "internal" in a couple of ways: - Functions, methods, and other objects prefixed by a leading underscore (``_``). This is the standard Python way of indicating that something is private; if any method starts with a single ``_``, it's an internal API. - -.. _misc-api-stability-localflavor: - -Local flavors -------------- - -:mod:`django.contrib.localflavor` contains assorted pieces of code -that are useful for particular countries or cultures. This data is -local in nature, and is subject to change on timelines that will -almost never correlate with Django's own release schedules. For -example, a common change is to split a province into two new -provinces, or to rename an existing province. - -These changes present two competing compatibility issues. Moving -forward, displaying the names of deprecated, renamed and dissolved -provinces in a selection widget is bad from a user interface -perspective. However, maintaining full backwards compatibility -requires that we support historical values that may be stored in a -database -- including values that may no longer be valid. - -Therefore, Django has the following policy with respect to changes in -local flavor: - -* At the time of a Django release, the data and algorithms - contained in :mod:`django.contrib.localflavor` will, to the best - of our ability, reflect the officially gazetted policies of the - appropriate local government authority. If a province has been - added, altered, or removed, that change will be reflected in - Django's localflavor. - -* These changes will *not* be backported to the previous stable - release. Upgrading a minor version of Django should not require - any data migration or audits for UI changes; therefore, if you - want to get the latest province list, you will either need to - upgrade your Django install, or backport the province list you - need. - -* For one release, the affected localflavor module will raise a - ``RuntimeWarning`` when it is imported. - -* The change will be announced in the release notes as a backwards - incompatible change requiring attention. The change will also be - annotated in the documentation for the localflavor module. - -* Where necessary and feasible, a migration script will be provided - to aid the migration process. - -For example, Django 1.2 contains an Indonesian localflavor. It has a -province list that includes "Nanggroe Aceh Darussalam (NAD)" as a -province. The Indonesian government has changed the official name of -the province to "Aceh (ACE)". As a result, Django 1.3 does *not* -contain "Nanggroe Aceh Darussalam (NAD)" in the province list, but -*does* contain "Aceh (ACE)". |
