diff options
| author | Aditya Chaudhary <113302312+userAdityaa@users.noreply.github.com> | 2024-10-02 21:45:21 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-02 13:15:21 -0300 |
| commit | efc3b0c627f7e3cb4e337280ecd2483758dcb0a5 (patch) | |
| tree | a1569a11bf5b8b3ab57ab3b042a1e2b999eb2f23 /docs | |
| parent | 6765b6adf924c1bc8792a4a454d5a788c1abc98e (diff) | |
Fixed #35670 -- Clarified the return value for LoginRequiredMiddleware's methods.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/middleware.txt | 16 |
1 files 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 <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 <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 |