mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
Code Issues 25 Releases Wiki Activity

[4.2.x] Refs #23528 -- Made cosmetic edits to swappable_dependency() docs.

Browse Source 
Backport of 1136aa5005 from main
This commit is contained in:
Mariusz Felisiak 2023-06-03 11:01:15 +01:00
parent 92ad551afd
commit 66d9fa4371
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/topics/migrations.txt
View File

@ -224,14 +224,14 @@ Swappable dependencies
.. function:: django.db.migrations.swappable_dependency(value)
The ``swappable_dependency()`` function is used in migrations to declare
"swappable" dependencies on migrations in the app of the swapped-in model.
Currently, the first migration of this app and as a consequence the swapped-in
"swappable" dependencies on migrations in the app of the swapped-in model,
currently, on the first migration of this app. As a consequence, the swapped-in
model should be created in the initial migration. The argument ``value`` is a
string ``"<app label>.<model>"`` describing an app label and a model name, e.g.
``"myapp.MyModel"``.
By using ``swappable_dependency()``, you inform the migration framework that
the migration relies on a migration which sets up up a swappable model,
the migration relies on another migration which sets up a swappable model,
allowing for the possibility of substituting the model with a different
implementation in the future. This is typically used for referencing models
that are subject to customization or replacement, such as the custom user