From c9b577ead6ca9a96e2066fd739b7c340dae5ca3a Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 15 Jan 2013 06:19:49 -0500 Subject: [PATCH] Clarified WizardView.get_form_prefix doc, refs #19024 --- docs/ref/contrib/formtools/form-wizard.txt | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/ref/contrib/formtools/form-wizard.txt b/docs/ref/contrib/formtools/form-wizard.txt index 8cd5d4ecd3c..ee9114acf9f 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 `. .. method:: WizardView.get_form_initial(step)