Opened 9 years ago

Closed 9 years ago

#25262 closed Cleanup/optimization (fixed)

Better document FlatPage.enable_comments and remove it from default ModelAdmin

Reported by: Aymeric Augustin Owned by: Y3K
Component: contrib.flatpages Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

This field isn't documented or used anywhere but it appears in the admin interface which is confusing.

Perhaps it was used by d.c.comments before we axed it?

Change History (5)

comment:2 by Tim Graham, 9 years ago

Easy pickings: set
Summary: Consider dropping FlatPage.enable_comments → Better document FlatPage.enable_comments and remove it from default ModelAdmin
Triage Stage: Unreviewed → Accepted

From the thread:

Me: A compromise could be to hide the field in the default ModelAdmin and let those who want it to enable it with a custom ModelAdmin. What do you think?

Aymeric: That would resolve my problem of “WTF is this field” without causing too much headache. We should also put a comment in the source code stating that the field is unused but we don’t want to remove it because of backwards-compatibility.

comment:3 by Y3K, 9 years ago

Owner: changed from nobody to Y3K
Status: new → assigned

I'll take this one, as my first Django ticket.

comment:4 by Y3K, 9 years ago

Has patch: set

Github pull request: ​https://github.com/django/django/pull/5204

  • Removed the field enable_comments from the FlatPageAdmin class.
  • Added the change to release notes for 1.9
  • Added the change to FlatPage documentation

comment:5 by Tim Graham <timograham@…>, 9 years ago

Resolution: → fixed
Status: assigned → closed

In b649f68:

Fixed #25262 -- Removed the enable_comments field from FlatPageAdmin.

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