Opened 10 years ago

Closed 9 years ago

Last modified 9 years ago

#16309 closed Bug (fixed)

Clarify "new in" notes in ModelAdmin.list_filter documentation

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

Description

In the documentation, post-1.3 changes to the ModelAdmin.list_filter API are now collectively marked as "Changed in Django Development version" just below the section title.

However, inside the section, "Field names in list_filter can also span relations using the __ lookup" is marked "New in Django 1.3", and e.g. "a class inheriting from django.contrib.admin.SimpleListFilter" is not marked at all.

This is a bit confusing. When we used SimpleListFilter, we missed the fact that that particular feature was added post-1.3. Wouldn't it be better if every list_filter feature was marked separately?

Attachments (2)

16309-documentation-admin-list_filter.1.diff (688 bytes) - added by Antti Kaihola 10 years ago.
Mark "SimpleListFilter" as "new in Django 1.4"
16309-documentation-admin-list_filter.2.diff (1.7 KB) - added by Antti Kaihola 10 years ago.
Mark both SimpleListFilter and FieldListFilter as "new in Django 1.4" instead of marking all of list_filter changed

Download all attachments as: .zip

Change History (6)

Changed 10 years ago by Antti Kaihola

Mark "SimpleListFilter" as "new in Django 1.4"

Changed 10 years ago by Antti Kaihola

Mark both SimpleListFilter and FieldListFilter as "new in Django 1.4" instead of marking all of list_filter changed

comment:1 Changed 10 years ago by Jannis Leidel

Patch needs improvement: set
Triage Stage: UnreviewedAccepted

comment:2 Changed 10 years ago by Julien Phalip

That looks good. There's just a small typo in the patch (a 't' character is hanging in the middle).

comment:3 Changed 9 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: newclosed

In [70896386ecc1808283e1f2f1fb9ced3bb0ac8301]:

Fixed #16309 - Made ModelAdmin.list_filter versionchanged annotations more specific to the sections that changed; thanks akaihola for the suggestion and patch.

comment:4 Changed 9 years ago by Tim Graham <timograham@…>

In [90fee02feeeed712a05d714d76d8acc07d3ed9a1]:

[1.4.X] Fixed #16309 - Made ModelAdmin.list_filter versionchanged annotations more specific to the sections that changed; thanks akaihola for the suggestion and patch.

Backport of 70896386ec from master

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