Browse Source

Clarified permission-related docs.

Tobias Bengfort 6 years ago
parent
commit
632d4861dd
2 changed files with 2 additions and 1 deletions
  1. 1 1
      docs/topics/auth/customizing.txt
  2. 1 0
      docs/topics/auth/index.txt

+ 1 - 1
docs/topics/auth/customizing.txt

@@ -95,7 +95,7 @@ a set of optional permission related :ref:`authorization methods
 
 The ``get_user`` method takes a ``user_id`` -- which could be a username,
 database ID or whatever, but has to be the primary key of your user object --
-and returns a user object.
+and returns a user object or ``None``.
 
 The ``authenticate`` method takes a ``request`` argument and credentials as
 keyword arguments. Most of the time, it'll just look like this::

+ 1 - 0
docs/topics/auth/index.txt

@@ -44,6 +44,7 @@ of these common problems have been implemented in third-party packages:
 * Password strength checking
 * Throttling of login attempts
 * Authentication against third-parties (OAuth, for example)
+* Object-level permissions
 
 Installation
 ============