Opened 3 months ago
Last modified 6 weeks ago
#35670 closed Cleanup/optimization
Unclear docs for LoginRequiredMiddleware.get_login_url() — at Initial Version
| Reported by: | Claude Paroz | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 5.1 |
| Severity: | Release blocker | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
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.
Note:
See TracTickets
for help on using tickets.