subject_prefix is not part of the IMailingList interface

Bug #1181498 reported by Aurélien Bompard
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
GNU Mailman
Fix Released
High
Barry Warsaw

Bug Description

In mailman/interfaces/mailinglist.py, in the IMailingList interface, there's a display_name property whoose documentation reads:
"This is used in locations such as the message footers and Subject prefix.".
It's actually not true, in the MailingList model class (in mailman/model/mailinglist.py) there's a subject_prefix attribute for this value, and it's the one that Postorius edits.
Thus the interface is incomplete (which is not a big problem) and the documentation is misleading (which is a bigger problem IMHO).

tags: added: documentation mailman3
Revision history for this message
Barry Warsaw (barry) wrote :

Note that what really happens is that the display name is taken as the default, initial value of the text to put inside the square brackets, when the default style is used. See src/mailman/styles/base.py for details.

Thanks for noting this. I will add subject_prefix to the interface and update the display_name docstring.

Changed in mailman:
milestone: none → 3.0.0b4
assignee: nobody → Barry Warsaw (barry)
importance: Undecided → High
status: New → In Progress
Barry Warsaw (barry)
Changed in mailman:
status: In Progress → Fix Committed
Barry Warsaw (barry)
Changed in mailman:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.