Skip to content

Commit

Permalink
[1.5.x] Clarified WizardView.get_form_prefix doc, refs #19024
Browse files Browse the repository at this point in the history
Backport of c9b577e from master
  • Loading branch information
timgraham committed Jan 15, 2013
1 parent 360676d commit b782870
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/ref/contrib/formtools/form-wizard.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit b782870

Please sign in to comment.