Author: ramiro
Date: 2011-10-16 13:38:22 -0700 (Sun, 16 Oct 2011)
New Revision: 16998
Modified:
django/trunk/docs/ref/contrib/formtools/form-wizard.txt
Log:
Fixed #17023 -- Unified `WizardView` `process_step()` documentation. Thanks
semente for the report.
Modified: django/trunk/docs/ref/contrib/formtools/form-wizard.txt
===================================================================
--- django/trunk/docs/ref/contrib/formtools/form-wizard.txt 2011-10-16
20:06:59 UTC (rev 16997)
+++ django/trunk/docs/ref/contrib/formtools/form-wizard.txt 2011-10-16
20:38:22 UTC (rev 16998)
@@ -252,20 +252,6 @@
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,13 +354,20 @@
.. 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)
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
