Browse files

Fixed #20326 - Corrected form wizard get_form() example.

Thanks tris@ for the report.
  • Loading branch information...
1 parent f513764 commit 646a2216e97a581314c9a2598d481b9e954f2e47 @timgraham timgraham committed May 31, 2013
Showing with 9 additions and 2 deletions.
  1. +9 −2 docs/ref/contrib/formtools/form-wizard.txt
View
11 docs/ref/contrib/formtools/form-wizard.txt
@@ -420,8 +420,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
@@ -433,6 +435,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

0 comments on commit 646a221

Please sign in to comment.