Skip to content

Commit

Permalink
Fixed #17023 -- Unified WizardView process_step() documentation. …
Browse files Browse the repository at this point in the history
…Thanks semente for the report.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16998 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
ramiro committed Oct 16, 2011
1 parent 5f2be4e commit 313fab8
Showing 1 changed file with 8 additions and 15 deletions.
23 changes: 8 additions & 15 deletions docs/ref/contrib/formtools/form-wizard.txt
Original file line number Diff line number Diff line change
Expand Up @@ -252,20 +252,6 @@ Advanced ``WizardView`` methods
the step itself. For more, see the :ref:`form prefix documentation
<form-prefix>`.

.. method:: WizardView.process_step(form)

Hook for modifying the wizard's internal state, given a fully validated
:class:`~django.forms.Form` object. The Form is guaranteed to have clean,
valid data.

Note that this method is called every time a page is rendered for *all*
submitted steps.

The default implementation::

def process_step(self, form):
return self.get_form_step_data(form)

.. method:: WizardView.get_form_initial(step)

Returns a dictionary which will be passed as the
Expand Down Expand Up @@ -368,12 +354,19 @@ Advanced ``WizardView`` methods

.. method:: WizardView.process_step(form)

Hook for modifying the wizard's internal state, given a fully validated
:class:`~django.forms.Form` object. The Form is guaranteed to have clean,
valid data.

This method gives you a way to post-process the form data before the data
gets stored within the storage backend. By default it just returns the
``form.data`` dictionary. You should not manipulate the data here but you
can use it to do some extra work if needed (e.g. set storage extra data).

Default implementation::
Note that this method is called every time a page is rendered for *all*
submitted steps.

The default implementation::

def process_step(self, form):
return self.get_form_step_data(form)
Expand Down

0 comments on commit 313fab8

Please sign in to comment.