summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Godwin <andrew@aeracode.org>2014-09-05 11:38:44 -0700
committerAndrew Godwin <andrew@aeracode.org>2014-09-05 11:41:22 -0700
commitffa9e60638bc1447cba9ddef4585b70267c435f7 (patch)
treebff20b70094f806917426443d994b50825799d03
parentd0c6016367c11d4d4cc42ace340f951f5b75738e (diff)
[1.7.x] Fixed #22534: Reinforce swappable documentation
-rw-r--r--docs/ref/models/fields.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index c99f717a29..b762b0357b 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1268,6 +1268,12 @@ The possible values for :attr:`~ForeignKey.on_delete` are found in
model should always point towards the swapped-in model - for example,
if it is a profile model designed specifically for your custom user model.
+ Setting it to ``False`` does not mean you can reference a swappable model
+ even if it is swapped out - ``False`` just means that the migrations made
+ with this ForeignKey will always reference the exact model you specify
+ (so it will fail hard if the user tries to run with a User model you don't
+ support, for example).
+
If in doubt, leave it to its default of ``True``.
.. _ref-manytomany: