diff options
| author | Tim Graham <timograham@gmail.com> | 2013-01-15 06:19:49 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-01-15 08:09:43 -0500 |
| commit | b7828705c8a87a079b6226caf959c821bd51fa91 (patch) | |
| tree | a9b3060bd26d752b1bb6e8f106f94699dec19fee /docs | |
| parent | 360676d9d86ed36a2ffcf1318904b2b56cfae641 (diff) | |
[1.5.x] Clarified WizardView.get_form_prefix doc, refs #19024
Backport of c9b577ead6 from master
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/formtools/form-wizard.txt | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/ref/contrib/formtools/form-wizard.txt b/docs/ref/contrib/formtools/form-wizard.txt index 8cd5d4ecd3..ee9114acf9 100644 --- a/docs/ref/contrib/formtools/form-wizard.txt +++ b/docs/ref/contrib/formtools/form-wizard.txt @@ -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) |
