Context Navigation

← Previous Ticket
Next Ticket →

#19024 closed Cleanup/optimization (fixed)

FormWizard WizardView.get_form_prefix form argument is unused

Reported by:	kenth	Owned by:	steph
Component:	contrib.formtools	Version:	dev
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

The documentation shows WizardView.get_for_prefix(step). Actual definition is
def get_form_prefix(self, step=None, form=None): In practice, the form argument is passed.

Attachments (1)

19024.diff (1.2 KB ) - added by Tim Graham 12 years ago.

Download all attachments as: .zip

Change History (12)

comment:1 by Claude Paroz, 12 years ago

Easy pickings:	set
Triage Stage:	Unreviewed → Accepted

by Tim Graham, 12 years ago

Attachment:	19024.diff added

comment:2 by Tim Graham, 12 years ago

Component:	Documentation → contrib.formtools
Has patch:	set
Summary:	FormWizard WizardView.get_form_prefix signature incorrect → FormWizard WizardView.get_form_prefix form argument is unused
Triage Stage:	Accepted → Ready for checkin
Type:	Bug → Cleanup/optimization

Actually, this argument isn't used so I'd suggest we remove it.

comment:3 by Claude Paroz, 12 years ago

To be completely sure, you could try to ping Stephan Jaekel, which might be the original author of this code (https://github.com/stephrdev/django-formwizard/commit/1301efd06383df727e455d08eee3ef3dc1f98d27).

comment:4 by steph, 12 years ago

I think removing the argument isn't a good idea. The get_form_prefix method is public api and some developers may use the form argument to determine the form prefix. Therefore, I updated the docs for the get_form_prefix method. (Please see https://github.com/stephrdev/django/commit/aa5b0a3ae8ff7abef3c64787dc09ff1ce17993c1)

comment:5 by steph, 12 years ago

Owner:	changed from nobody to steph
Status:	new → assigned

comment:6 by Claude Paroz <claude@…>, 12 years ago

Resolution:	→ fixed
Status:	assigned → closed

In 17f8496fea9b866769b2d2a04326acbe25e9256f:

Fixed #19024 -- Corrected form wizard docs for get_form_prefix.

comment:7 by Claude Paroz <claude@…>, 12 years ago

In f16eb0b0d049595f837005986b1db539528fef2f:

[1.5.x] Fixed #19024 -- Corrected form wizard docs for get_form_prefix.

Backport of 17f8496fe from master.

comment:8 by Tim Graham <timograham@…>, 12 years ago

In c9b577ead6ca9a96e2066fd739b7c340dae5ca3a:

Clarified WizardView.get_form_prefix doc, refs #19024

comment:9 by Tim Graham <timograham@…>, 12 years ago

In b7828705c8a87a079b6226caf959c821bd51fa91:

[1.5.x] Clarified WizardView.get_form_prefix doc, refs #19024

Backport of c9b577ead6 from master

comment:10 by Claude Paroz <claude@…>, 12 years ago