summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAndrew Miller <info@akmiller.co.uk>2024-06-28 15:10:50 +0100
committerNatalia <124304+nessita@users.noreply.github.com>2024-07-01 21:53:02 -0300
commitfb140420bd54cdd3bcc1e51442d631f233213989 (patch)
tree7effef5d0bcba84c3cffca0931d19dd8fc8d2e37 /docs
parenta6dd2880f5da6903cf4131e7f4d18ed9316c710c (diff)
[5.1.x] Fixed #23790 -- Warned about renaming AppConfig.label in docs/ref/applications.txt.
Backport of aa74c4083e047473ac385753e047e075e8f04890 from main.
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 03063f2086..3869f4a8b4 100644
--- 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".