Browse files

[1.5.x] Fixed #20394 - Clarified argument of get_user in docs

Backport of 1172bef from master.
  • Loading branch information...
1 parent cac0f7b commit be6e7ff6ebda7acca71e32c2e7890c62e98ba81a @makto makto committed with timgraham May 11, 2013
Showing with 2 additions and 1 deletion.
  1. +2 −1 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::

0 comments on commit be6e7ff

Please sign in to comment.