[1.5.x] Fixed #20326 - Corrected form wizard get_form() example.

Thanks tris@ for the report.

Backport of 646a2216e9 from master
This commit is contained in:
Tim Graham 2013-05-31 08:07:40 -04:00
parent e873de0a5a
commit 1c5cccedb4
1 changed files with 9 additions and 2 deletions

View File

@ -405,8 +405,10 @@ Advanced ``WizardView`` methods
.. method:: WizardView.get_form(step=None, data=None, files=None)
This method constructs the form for a given ``step``. If no ``step`` is
defined, the current step will be determined automatically.
The method gets three arguments:
defined, the current step will be determined automatically. If you override
``get_form``, however, you will need to set ``step`` yourself using
``self.steps.current`` as in the example below. The method gets three
arguments:
* ``step`` -- The step for which the form instance should be generated.
* ``data`` -- Gets passed to the form's data argument
@ -418,6 +420,11 @@ Advanced ``WizardView`` methods
def get_form(self, step=None, data=None, files=None):
form = super(MyWizard, self).get_form(step, data, files)
# determine the step if not given
if step is None:
step = self.steps.current
if step == '1':
form.user = self.request.user
return form