Permalink
Browse files

Refs #14881 -- Document that User models need to have an integer prim…

…ary key.

Thanks to Kaloian Minkov for the reminder about this undocumented requirement.
  • Loading branch information...
1 parent 87854b0 commit 91c26eadc9b4efa5399ec0f6c84b56a3f8eb84f4 @freakboy3742 freakboy3742 committed Feb 16, 2013
Showing with 4 additions and 2 deletions.
  1. +4 −2 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

0 comments on commit 91c26ea

Please sign in to comment.