summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzhongqi <zhongqi90@gmail.com>2013-05-11 15:53:54 +0800
committerTim Graham <timograham@gmail.com>2013-05-13 14:07:37 -0400
commitbe6e7ff6ebda7acca71e32c2e7890c62e98ba81a (patch)
treecfac9e23411ce3eaf88e235a1d157b3ec0deac49
parentcac0f7b72e5d42239803df5338db03f1d19c22e6 (diff)
[1.5.x] Fixed #20394 - Clarified argument of get_user in docs
Backport of 1172bef998 from master.
-rw-r--r--docs/topics/auth/customizing.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt
index d9c6df145a..2aa01b3ab9 100644
--- a/docs/topics/auth/customizing.txt
+++ b/docs/topics/auth/customizing.txt
@@ -89,7 +89,8 @@ An authentication backend is a class that implements two required methods:
optional permission related :ref:`authorization methods <authorization_methods>`.
The ``get_user`` method takes a ``user_id`` -- which could be a username,
-database ID or whatever -- and returns a ``User`` object.
+database ID or whatever, but has to be the primary key of your ``User`` object
+-- and returns a ``User`` object.
The ``authenticate`` method takes credentials as keyword arguments. Most of
the time, it'll just look like this::