Code

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#16597 closed Bug (fixed)

FormWizard doco mentions get_template_names() but does not document it.

Reported by: FunkyBob Owned by: jkistler
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: 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

Under the section "Creating templates for the forms" in https://docs.djangoproject.com/en/dev//ref/contrib/formtools/form-wizard/#creating-templates-for-the-forms it says "You can change this template name by overriding either the template_name attribute or the get_template_names() method, which is documented below", but it is not listed anywhere else on the page.

Given it inherits from a TemplateView, it should probably link off to the TemplateView.get_template_names doco: https://docs.djangoproject.com/en/dev//ref/class-based-views/#django.views.generic.base.TemplateResponseMixin.get_template_names

Attachments (1)

16597_patch.diff (901 bytes) - added by jkistler 3 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 3 years ago by aaugustin

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

Changed 3 years ago by jkistler

comment:2 Changed 3 years ago by jkistler

  • Owner changed from nobody to jkistler

comment:3 Changed 3 years ago by jkistler

Added a patch that points to the TemplateResponseMixin documentation explaining get_template_names()

comment:4 Changed 3 years ago by jezdez

  • Triage Stage changed from Accepted to Ready for checkin

comment:5 Changed 3 years ago by jkistler

  • Has patch set

comment:6 Changed 3 years ago by ramiro

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

In [16904]:

Fixed #16597 -- Added Sphinx cross-reference metadata to the form wizard docs. Thanks FunkyBob for the report and jkistler for the patch.

Also, additional fixes in that document and in the WizardView docstrings.

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.