summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRussell Keith-Magee <russell@keith-magee.com>2013-02-16 10:21:05 +0800
committerRussell Keith-Magee <russell@keith-magee.com>2013-02-16 10:21:05 +0800
commit91c26eadc9b4efa5399ec0f6c84b56a3f8eb84f4 (patch)
tree9c2a61cd703e2b288719dc2950267fd618823731 /docs
parent87854b0bdf354059f949350a4d63a0ed071d564c (diff)
Refs #14881 -- Document that User models need to have an integer primary key.
Thanks to Kaloian Minkov for the reminder about this undocumented requirement.
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/auth/customizing.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt
index d1ce6eb7dc..9c31445455 100644
--- a/docs/topics/auth/customizing.txt
+++ b/docs/topics/auth/customizing.txt
@@ -466,11 +466,13 @@ Specifying a custom User model
Django expects your custom User model to meet some minimum requirements.
-1. Your model must have a single unique field that can be used for
+1. Your model must have an integer primary key.
+
+2. Your model must have a single unique field that can be used for
identification purposes. This can be a username, an email address,
or any other unique attribute.
-2. Your model must provide a way to address the user in a "short" and
+3. Your model must provide a way to address the user in a "short" and
"long" form. The most common interpretation of this would be to use
the user's given name as the "short" identifier, and the user's full
name as the "long" identifier. However, there are no constraints on