Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

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

Backport of c9b577e from master
  • Loading branch information...
commit b7828705c8a87a079b6226caf959c821bd51fa91 1 parent 360676d
@timgraham timgraham authored
Showing with 8 additions and 3 deletions.
  1. +8 −3 docs/ref/contrib/formtools/form-wizard.txt
View
11 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)
Please sign in to comment.
Something went wrong with that request. Please try again.