#2610 closed defect (fixed)
Docs on auth context processor are incorrect
Reported by: | James Bennett | Owned by: | Jacob |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | normal | Keywords: | |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
The docs for django.core.context_processors.auth
state that the messages
variable returned to the context will be "A list of auth.Message objects for the currently logged-in user." That's not correct, though; the context processor is doing get_and_delete_messages
on request.user
, which iterates over the Message
objects and returns the message
attribute of each, not the objects themselves.
Note:
See TracTickets
for help on using tickets.
(In [3685]) Fixed #2610 -- Clarified docs on 'messages' variable for auth context processor