Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#18173 closed Cleanup/optimization (fixed)

Modeladmin documentation for get_changelist suggests its an attribute

Reported by: Keryn Knight <django@…> Owned by: vanessagomes
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: vanessagomes Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Based on the admin docs, get_changelist is an attribute, and has been since #16195. However, looking at the source, it's a method and is used as a callable to get the class. I'm proposing it be moved from the options to the methods section instead.

Attachments (1)

ticket18173-patch.diff (1.3 KB) - added by vanessagomes 3 years ago.
Description of get_changelist was moved to the methods section.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 3 years ago by moritzs

  • Easy pickings set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Cleanup/optimization

It's a good idea to move it to the methods section.

In addition the documentation should be more specific: The get_changelist method gets passed a request object and should return a class inherited from django.contrib.admin.views.main.ChangeList.

comment:2 Changed 3 years ago by vanessagomes

  • Owner changed from nobody to vanessagomes

Changed 3 years ago by vanessagomes

Description of get_changelist was moved to the methods section.

comment:3 Changed 3 years ago by vanessagomes

  • Has patch set

comment:4 Changed 3 years ago by claudep

  • Triage Stage changed from Accepted to Ready for checkin

comment:5 Changed 3 years ago by vanessagomes

  • Cc vanessagomes added

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

  • Resolution set to fixed
  • Status changed from new to closed

In [d44aa98184ced66d95ba95d0e4a255d09c15df0c]:

Fixed #18173 - Corrected ModelAdmin documentation for get_changelist.

Thanks Keryn Knight for the report and vanessagomes for the patch.

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

In [dcede04715fb4896ae7892c2a63ea534496ee0bf]:

[1.4.x] Fixed #18173 - Corrected ModelAdmin documentation for get_changelist.

Thanks Keryn Knight for the report and vanessagomes for the pckport of [d44aa98] from master.atch.

Backport of [d44aa98] from master.

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