[Checkins] SVN: grok/trunk/src/grok/components.py Improve docstrings by explaining why we have update() and update_form() in

[Philipp von Weitershausen]

Log message for revision 73225:
  Improve docstrings by explaining why we have update() and update_form() in
  GrokForm.
  

Changed:
  U   grok/trunk/src/grok/components.py

-=-
Modified: grok/trunk/src/grok/components.py
===================================================================
--- grok/trunk/src/grok/components.py	2007-03-16 17:55:28 UTC (rev 73224)
+++ grok/trunk/src/grok/components.py	2007-03-16 17:58:13 UTC (rev 73225)
@@ -365,12 +365,16 @@
         happens."""
 
     def update_form(self):
-        """Update the form, meaning, process form input using widgets."""
+        """Update the form, i.e. process form input using widgets.
+
+        On zope.formlib forms, this is what the update() method is.
+        In grok views, the update() method has a different meaning.
+        That's why this method is called update_form() in grok forms."""
         super(GrokForm, self).update()
 
     def render(self):
-        """Render the form, either using the form templates or
-        whatever the actions returned in form_result."""
+        """Render the form, either using the form template or whatever
+        the actions returned in form_result."""
         # if the form has been updated, it will already have a result
         if self.form_result is None:
             if self.form_reset: