[Erp5-report] r45895 guillaume.bottex - /slapos/trunk/util/slapos.tool.nosqltester/src/slap...

[nobody at svn.erp5.org]

Author: guillaume.bottex
Date: Wed Jun 15 11:08:38 2011
New Revision: 45895

URL: http://svn.erp5.org?rev=45895&view=rev
Log:
Update the comments.

Modified:
    slapos/trunk/util/slapos.tool.nosqltester/src/slapos/tool/nosqltester/__init__.py

Modified: slapos/trunk/util/slapos.tool.nosqltester/src/slapos/tool/nosqltester/__init__.py
URL: http://svn.erp5.org/slapos/trunk/util/slapos.tool.nosqltester/src/slapos/tool/nosqltester/__init__.py?rev=45895&r1=45894&r2=45895&view=diff
==============================================================================
--- slapos/trunk/util/slapos.tool.nosqltester/src/slapos/tool/nosqltester/__init__.py [utf8] (original)
+++ slapos/trunk/util/slapos.tool.nosqltester/src/slapos/tool/nosqltester/__init__.py [utf8] Wed Jun 15 11:08:38 2011
@@ -81,11 +81,13 @@ class NoSQLTester(object):
     @app.route('/result/<report>')
     def download(report):
       """
-      Sends the requested :param report: file.
+      Sends the requested *report* file.
       
       :params report: Name of the file to send.
       :type report: unicode.
       
+      :returns: data to send.
+      
       """
       
       try:
@@ -119,6 +121,8 @@ class NoSQLTester(object):
     def action():
       """
       Starts or stops the testing process.
+      
+      :returns: empty string.
       """
       
       if request.method == 'POST' and 'action' in request.form:
@@ -181,6 +185,8 @@ class NoSQLTester(object):
     """
     Runs the testing process.
     
+    :returns: int -- the subprocess execution result code.
+    
     .. note::
       You may need to override this method in an inheritance class.