Fixed #23790 -- Warned about renaming AppConfig.label in docs/ref/app…

…lications.txt.
felixxm · Jul 2, 2024 · aa74c40 · aa74c40
1 parent 289f48c
commit aa74c40
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -87,6 +87,7 @@ answer newbie questions, and generally made Django that much better:
     Andrew Clark <[email protected]>
     Andrew Durdin <[email protected]>
     Andrew Godwin <[email protected]>
+    Andrew Miller <[email protected]>
     Andrew Pinkham <http://AndrewsForge.com>
     Andrews Medina <[email protected]>
     Andrew Northall <[email protected]>

diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt
@@ -186,6 +186,14 @@ Configurable attributes
 
     It must be unique across a Django project.
 
+    .. warning::
+
+        Changing this attribute after migrations have been applied for an
+        application will result in breaking changes to a project or, in the
+        case of a reusable app, any existing installs of that app. This is
+        because ``AppConfig.label`` is used in database tables and migration
+        files when referencing an app in the dependencies list.
+
 .. attribute:: AppConfig.verbose_name
 
     Human-readable name for the application, e.g. "Administration".