summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAymeric Augustin <aymeric.augustin@m4x.org>2015-09-21 22:42:35 +0200
committerAymeric Augustin <aymeric.augustin@m4x.org>2015-09-22 08:32:39 +0200
commit76bf4bc1117524eb1305395451455b372e518c91 (patch)
tree391dcd6b60f3bb5dccf53330133dfd13b00c0cb6 /docs
parent528c1330f85914eb6b3f253932172695871f7905 (diff)
[1.8.x] Recommended against default_app_config.
Most likely this is a losing fight -- people seem to love this small convention -- but at least the reasons for avoiding it will be documented. Refs #25356. Backport of 94a36cf from master
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/applications.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt
index 4870e74577..a51b918e66 100644
--- a/docs/ref/applications.txt
+++ b/docs/ref/applications.txt
@@ -59,6 +59,14 @@ subclass for that application.
If there is no ``default_app_config``, Django uses the base
:class:`~django.apps.AppConfig` class.
+``default_app_config`` allows applications that predate Django 1.7 such as
+``django.contrib.admin`` to opt-in to :class:`~django.apps.AppConfig` features
+without requiring users to update their :setting:`INSTALLED_APPS`.
+
+New applications should avoid ``default_app_config``. Instead they should
+require the dotted path to the appropriate :class:`~django.apps.AppConfig`
+subclass to be configured explicitly in :setting:`INSTALLED_APPS`.
+
For application authors
-----------------------