Clarified WizardView.get_form_prefix doc, refs #19024
This commit is contained in:
parent
43f89e0ad6
commit
c9b577ead6
|
@ -318,10 +318,15 @@ Advanced ``WizardView`` methods
|
||||||
counter as string representing the current step of the wizard. (E.g., the
|
counter as string representing the current step of the wizard. (E.g., the
|
||||||
first form is ``'0'`` and the second form is ``'1'``)
|
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>`.
|
For more, see the :ref:`form prefix documentation <form-prefix>`.
|
||||||
|
|
||||||
.. method:: WizardView.get_form_initial(step)
|
.. method:: WizardView.get_form_initial(step)
|
||||||
|
|
Loading…
Reference in New Issue