From efc3b0c627f7e3cb4e337280ecd2483758dcb0a5 Mon Sep 17 00:00:00 2001 From: Aditya Chaudhary <113302312+userAdityaa@users.noreply.github.com> Date: Wed, 2 Oct 2024 21:45:21 +0530 Subject: [PATCH] Fixed #35670 -- Clarified the return value for LoginRequiredMiddleware's methods. --- docs/ref/middleware.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/ref/middleware.txt b/docs/ref/middleware.txt index 4aab186c8b..ded684b972 100644 --- a/docs/ref/middleware.txt +++ b/docs/ref/middleware.txt @@ -563,19 +563,19 @@ unauthenticated requests. .. method:: get_login_url() - Returns the URL that unauthenticated requests will be redirected to. If - defined, this returns the ``login_url`` set on the - :func:`~.django.contrib.auth.decorators.login_required` decorator. Defaults - to :setting:`settings.LOGIN_URL `. + Returns the URL that unauthenticated requests will be redirected to. This + result is either the ``login_url`` set on the + :func:`~django.contrib.auth.decorators.login_required` decorator (if not + ``None``), or :setting:`settings.LOGIN_URL `. .. method:: get_redirect_field_name() Returns the name of the query parameter that contains the URL the user - should be redirected to after a successful login. If defined, this returns + should be redirected to after a successful login. This result is either the ``redirect_field_name`` set on the - :func:`~.django.contrib.auth.decorators.login_required` decorator. Defaults - to :attr:`redirect_field_name`. If ``None`` is returned, a query parameter - won't be added. + :func:`~.django.contrib.auth.decorators.login_required` decorator (if not + ``None``), or :attr:`redirect_field_name`. If ``None`` is returned, a query + parameter won't be added. .. class:: RemoteUserMiddleware