Code

Opened 4 months ago

Closed 4 months ago

#21591 closed Cleanup/optimization (fixed)

get_messages is not covered in the documentation

Reported by: merb Owned by: nobody
Component: Documentation Version: master
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.

Attachments (0)

Change History (3)

comment:1 Changed 4 months ago by bmispelon

  • Keywords messages added
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Version changed from 1.6 to master

Sounds like a reasonable addition to the documentation.

comment:2 Changed 4 months ago by Natim87

  • Cc Natim87 added
  • Has patch set

comment:3 Changed 4 months ago by Baptiste Mispelon <bmispelon@…>

  • Resolution set to fixed
  • Status changed from new to 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.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.