Code

Opened 2 years ago

Closed 2 years ago

#18113 closed Cleanup/optimization (fixed)

Class based view mixin docstrings reference incorrect method

Reported by: Keryn Knight <django@…> Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords: get_template CBV
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Both the SingleObjectTemplateResponseMixin and the MultipleObjectTemplateResponseMixin (detail and list, respectively) have the following docstring for the method get_template_names()

Return a list of template names to be used for the request. Must return
a list. May not be called if get_template is overridden.

However, looking through all the generic views, and grepping SVN trunk, I can't find anywhere get_template itself is being defined, or used. The closest thing I can find is the legacy form wizard having that method.

Attachments (0)

Change History (2)

comment:1 Changed 2 years ago by jezdez

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 2 years ago by Claude Paroz <claude@…>

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

In [ed7ea5a6020cb3e09a7f05c4206a11196766bbd2]:

Fixed #18113 -- Corrected get_template_names docstrings.

Thanks Keryn Knight for the report.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.