Opened 10 years ago

Closed 10 years ago

#21591 closed Cleanup/optimization (fixed)

get_messages is not covered in the documentation

Reported by: merb Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords: messages
Cc: Natim87 Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Currently theres a get_messages method in the django messages framework which could be used to get messages.
At the moment it's not covered in the documentation.

There is only one note about how to avoid clearing messages.

​https://docs.djangoproject.com/en/dev/ref/contrib/messages/#expiration-of-messages

Btw. this cleanup needs to be done, since more and more people use ajax or an REST API to query some django stuff. so you can't access the messages in the template. It would be good if somebody will introduce the 

get_messages(request)

function in the documentation.

Change History (3)

comment:1 by Baptiste Mispelon, 10 years ago

Keywords: messages added
Triage Stage: Unreviewed → Accepted
Version: 1.6 → master

Sounds like a reasonable addition to the documentation.

comment:2 by Natim87, 10 years ago

Cc: Natim87 added
Has patch: set

PR here : ​https://github.com/django/django/pull/2066

comment:3 by Baptiste Mispelon <bmispelon@…>, 10 years ago

Resolution: → fixed
Status: new → closed

In 24fcca6bddca3db33ac73c29ad9167ac279e4d94:

Fixed #21591 -- Added documentation about contrib.messages.get_messages.

Refs https://code.djangoproject.com/ticket/21591
Thanks to track user merb for the report.

Note: See TracTickets for help on using tickets.
Back to Top