From ae5b6627965bc8342ad533e7c4dcb5bde3bcedc8 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Wed, 16 Apr 2014 07:47:56 -0400 Subject: [PATCH] Added a note regarding django.contrib.auth.authenticate. Thanks Josh Brown for the suggestion. --- docs/topics/auth/default.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt index ec94400a7e..15af543fa1 100644 --- a/docs/topics/auth/default.txt +++ b/docs/topics/auth/default.txt @@ -142,6 +142,16 @@ Authenticating Users # the authentication system was unable to verify the username and password print("The username and password were incorrect.") + .. note:: + + This is a low level way to authenticate a set of credentials; for + example, it's used by the + :class:`~django.contrib.auth.middleware.RemoteUserMiddleware`. Unless + you are writing your own authentication system, you probably won't use + this. Rather if you are looking for a way to limit access to logged in + users, see the :func:`~django.contrib.auth.decorators.login_required` + decorator. + .. _topic-authorization: Permissions and Authorization