[Erp5-report] r44963 arnaud.fontaine - /erp5/trunk/utils/erp5.utils.test_browser/src/erp5/u...

[nobody at svn.erp5.org]

Author: arnaud.fontaine
Date: Fri Apr  1 04:26:53 2011
New Revision: 44963

URL: http://svn.erp5.org?rev=44963&view=rev
Log:
Document submitLogin()

Modified:
    erp5/trunk/utils/erp5.utils.test_browser/src/erp5/utils/test_browser/browser.py

Modified: erp5/trunk/utils/erp5.utils.test_browser/src/erp5/utils/test_browser/browser.py
URL: http://svn.erp5.org/erp5/trunk/utils/erp5.utils.test_browser/src/erp5/utils/test_browser/browser.py?rev=44963&r1=44962&r2=44963&view=diff
==============================================================================
--- erp5/trunk/utils/erp5.utils.test_browser/src/erp5/utils/test_browser/browser.py [utf8] (original)
+++ erp5/trunk/utils/erp5.utils.test_browser/src/erp5/utils/test_browser/browser.py [utf8] Fri Apr  1 04:26:53 2011
@@ -488,7 +488,12 @@ class MainForm(Form):
 
   def submitLogin(self):
     """
-    Log into ERP5 using the username and password provided in the browser.
+    Log into ERP5 using the username and password provided in the
+    browser. It is assumed that the current page is the login page (by
+    calling C{open('login_form')} beforehand).
+
+    This method should rarely be used by scripts as login is already
+    performed upon instanciation of Browser class.
 
     @raise LoginError: Login failed