summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorAmar Ahmed Deina <amarmed4500@gmail.com>2026-01-07 02:47:58 +0000
committerJacob Walls <jacobtylerwalls@gmail.com>2026-01-08 10:20:38 -0500
commit091ffc4e5eb35776864b853973097588a36f169e (patch)
tree42de5d232a9899b63fa3ea15d4ea69010603a09d /docs/ref
parent2be860d6cfb04c9b3643f7c31ce90df280c8e747 (diff)
Fixed #36844 -- Clarified need for reusable apps to set default_auto_field in packaging tutorial and AppConfig docs.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/applications.txt14
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt
index 7801e8f438..ce6d559488 100644
--- a/docs/ref/applications.txt
+++ b/docs/ref/applications.txt
@@ -227,9 +227,17 @@ Configurable attributes
.. attribute:: AppConfig.default_auto_field
- The implicit primary key type to add to models within this app. You can
- use this to keep :class:`~django.db.models.AutoField` as the primary key
- type for third party applications.
+ The implicit primary key type to add to models within this app.
+
+ Reusable applications that define models **must** set this attribute to
+ ensure migrations included in the application match the models. Otherwise,
+ migrations will be generated for the application when a user runs
+ :djadmin:`makemigrations` with a different :setting:`DEFAULT_AUTO_FIELD`,
+ which may conflict with future migrations shipped by the application.
+
+ For example, to keep using :class:`~django.db.models.AutoField`::
+
+ default_auto_field = "django.db.models.AutoField"
By default, this is the value of :setting:`DEFAULT_AUTO_FIELD`.