#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)
Change History (6)
by , 13 years ago
| Attachment: | 16309-documentation-admin-list_filter.1.diff added |
|---|
by , 13 years ago
| Attachment: | 16309-documentation-admin-list_filter.2.diff added |
|---|
Mark both SimpleListFilter and FieldListFilter as "new in Django 1.4" instead of marking all of list_filter changed
comment:1 by , 13 years ago
| Patch needs improvement: | set |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 13 years ago
That looks good. There's just a small typo in the patch (a 't' character is hanging in the middle).
comment:3 by , 12 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
Mark "SimpleListFilter" as "new in Django 1.4"