p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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
This commit is contained in:
Ramiro Morales 2011-10-16 20:38:22 +00:00
parent 5f2be4ecbb
commit 313fab8623
1 changed files with 8 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/ref/contrib/formtools/form-wizard.txt
View File

@ -252,20 +252,6 @@ Advanced ``WizardView`` methods
the step itself. For more, see the :ref:`form prefix documentation the step itself. For more, see the :ref:`form prefix documentation
<form-prefix>`. <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) .. method:: WizardView.get_form_initial(step)
Returns a dictionary which will be passed as the Returns a dictionary which will be passed as the
@ -368,12 +354,19 @@ Advanced ``WizardView`` methods
.. method:: WizardView.process_step(form) .. 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 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 gets stored within the storage backend. By default it just returns the
``form.data`` dictionary. You should not manipulate the data here but you ``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). 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): def process_step(self, form):
return self.get_form_step_data(form) return self.get_form_step_data(form)