Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#16841 closed Cleanup/optimization (fixed)

get_changelist_form and get_changelist_formset should be added to the documentation

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

Description

Currently the get_changelist_form is an undocumented feature. It should be added as one of the listed methods here:
https://docs.djangoproject.com/en/dev/ref/contrib/admin/#modeladmin-methods

Change History (7)

comment:1 Changed 5 years ago by Carl Meyer

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Summary: get_changelist_form should be added to the documentationget_changelist_form and get_changelist_formset should be added to the documentation
Triage Stage: UnreviewedAccepted

If get_changelist_form is documented, get_changelist_formset should be as well.

comment:2 Changed 5 years ago by Julien Phalip

ModelAdmin.get_form, ModelAdmin.get_formsets and InlineModelAdmin.get_formset could be as well, while we're at it :)

comment:3 Changed 5 years ago by Julien Phalip

Type: UncategorizedCleanup/optimization

comment:4 Changed 5 years ago by Julien Phalip

See also #17006.

comment:5 Changed 5 years ago by rasca

See also #17646

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

Resolution: fixed
Status: newclosed

In 39f5bc7fc3a4bb43ed8a1358b17fe0521a1a63ac:

Fixed #16841 - Documented a couple ModelAdmin methods

  • ModelAdmin.get_changelist_form and get_changelist_formset
  • InlineModelAdmin.get_formset

Thanks Jordan Reiter for the report.

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

In 4a9b3826fdfa1d78f640d4fee922005ed8210498:

[1.5.X] Fixed #16841 - Documented a couple ModelAdmin methods

  • ModelAdmin.get_changelist_form and get_changelist_formset
  • InlineModelAdmin.get_formset

Thanks Jordan Reiter for the report.

Backport of 39f5bc7fc3 from master

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