Unclear docs for LoginRequiredMiddleware.get_login_url()

[Claude Paroz]

I'm struggling to understand the second sentence of the documentation of LoginRequiredMiddleware.get_login_url() (​https://docs.djangoproject.com/en/5.1/ref/middleware/#django.contrib.auth.middleware.get_login_url).

If defined, this returns the login_url set on the login_required() decorator. Defaults to settings.LOGIN_URL.

After many reads, I think I get the point of the If defined that means if the login_required() defines login_url, then...
I'm sure we can do better. Same issue with the docs for get_redirect_field_name() below.

[Claude Paroz]

Maybe something like: "By default, it returns either a login_url attribute set on the view by a login_required decorator, or settings.LOGIN_URL."

[Sarah Boyce]

Agreed this could be worded better.

If ``login_url`` is set on the :func:`~.django.contrib.auth.decorators.login_required`
decorator, this is returned. Otherwise, returns :setting:`settings.LOGIN_URL <LOGIN_URL>`.

(as another option)

[Aditya Chaudhary]

@Samruddhi Dharankar, are you still working in this issue ?
Or shall I assign this to myself ?

[Jacob Walls]

​PR

[Natalia Bidart]

While this is purely a docs change, it strictly qualifies as a release blocker since it was introduced in c7fc9f20b49b5889a9a8f47de45165ac443c1a21.

[Natalia Bidart]

Will merge when CI is green, I also tweaked get_redirect_field_name() since it had the same English construct, making it challenging to understand.

[GitHub <noreply@…>]

In efc3b0c6:

Fixed #35670 -- Clarified the return value for LoginRequiredMiddleware's methods.

[Natalia <124304+nessita@…>]

In bf64ac3:

[5.1.x] Fixed #35670 -- Clarified the return value for LoginRequiredMiddleware's methods.

Backport of efc3b0c627f7e3cb4e337280ecd2483758dcb0a5 from main.