innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

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

Backport of c9b577ead6 from master
This commit is contained in:
Tim Graham 2013-01-15 06:19:49 -05:00
parent 360676d9d8
commit b7828705c8
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/ref/contrib/formtools/form-wizard.txt
View File

@ -318,10 +318,15 @@ Advanced ``WizardView`` methods
counter as string representing the current step of the wizard. (E.g., the
first form is ``'0'`` and the second form is ``'1'``)
.. method:: WizardView.get_form_prefix(step, form)
.. method:: WizardView.get_form_prefix(step=None, form=None)
Returns the prefix which will be used when calling the form for the given
step. ``step`` contains the step name, ``form`` the form class which will
be called with the returned prefix.
If no ``step`` is given, it will be determined automatically. By default,
this simply uses the step itself and the ``form`` parameter is not used.
Given the step and the form class which will be called with the returned
form prefix. By default, this simply uses the step itself.
For more, see the :ref:`form prefix documentation <form-prefix>`.
.. method:: WizardView.get_form_initial(step)