summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRamiro Morales <cramm0@gmail.com>2011-10-16 20:38:22 +0000
committerRamiro Morales <cramm0@gmail.com>2011-10-16 20:38:22 +0000
commit313fab8623d68be1361e4b3383f587d79fadecd7 (patch)
treee3ca8e077f5e004c5117fa92c88a7f890147fd51 /docs
parent5f2be4ecbb5df3760f4c6e49170478719d3026d7 (diff)
Fixed #17023 -- Unified `WizardView` `process_step()` documentation. Thanks semente for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16998 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/formtools/form-wizard.txt23
1 files changed, 8 insertions, 15 deletions
diff --git a/docs/ref/contrib/formtools/form-wizard.txt b/docs/ref/contrib/formtools/form-wizard.txt
index 2483ce91c6..ba2f4e8ae5 100644
--- a/docs/ref/contrib/formtools/form-wizard.txt
+++ b/docs/ref/contrib/formtools/form-wizard.txt
@@ -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
@@ -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)