Merge pull request #47 from avocado-framework/display-init-docs

Display init docs

avocado/plugins/xunit.py

@@ -152,6 +152,13 @@ class xUnitTestResult(TestResult):
 
     def __init__(self, stream=None, debuglog=None, loglevel=None,
                  tests_total=0, args=None):
+        """
+        :param stream: Stream where to write output, such as :attr:`sys.stdout`.
+        :param debuglog: Debug log file path.
+        :param loglevel: Log level in the :mod:`logging` module.
+        :param tests_total: Total of tests executed
+        :param args: :class:`argparse.Namespace` with cmdline arguments.
+        """
         TestResult.__init__(self, stream, debuglog, loglevel, tests_total, args)
         if hasattr(self.args, 'xunit_output'):
             self.filename = self.args.xunit_output
@@ -160,13 +167,22 @@ class xUnitTestResult(TestResult):
         self.xml = XmlResult()
 
     def start_tests(self):
+        """
+        Record a start tests event.
+        """
         TestResult.start_tests(self)
         self.xml.start_testsuite(datetime.datetime.now())
 
     def start_test(self, test):
+        """
+        Record a start test event.
+        """
         TestResult.start_test(self, test)
 
     def end_test(self, test):
+        """
+        Record an end test event, accord to the given test status.
+        """
         TestResult.end_test(self, test)
         if test.status == 'PASS':
             self.xml.add_success(test)
@@ -178,6 +194,9 @@ class xUnitTestResult(TestResult):
             self.xml.add_error(test)
 
     def end_tests(self):
+        """
+        Record an end tests event.
+        """
         TestResult.end_tests(self)
         values = {'tests': self.tests_total,
                   'errors': len(self.errors),

avocado/test.py

@@ -37,25 +37,6 @@ class Test(unittest.TestCase):
 
     You'll inherit from this to write your own tests. Tipically you'll want
     to implement setup(), action() and cleanup() methods on your own tests.
-
-    Test Attributes:
-
-    basedir:
-        Where the test .py file is located (root dir).
-    depsdir:
-        If this is an existing test suite wrapper, it'll contain the
-        test suite sources and other auxiliary files. Usually inside
-        basedir, 'deps' subdirectory.
-    workdir:
-        Place where temporary copies of the source code, binaries,
-        image files will be created and modified.
-    base_logdir:
-        Base log directory, where logs from all tests go to.
-    tag:
-        A name that can differentiate between 2 executions of the same test
-        name.
-    job:
-        The job that this test is part of.
     """
 
     def __init__(self, methodName='runTest', name=None, base_logdir=None,

avocado/utils/crypto.py

@@ -89,13 +89,14 @@ def hash_file(filename, size=None, algorithm="md5"):
 
     If size is not None, limit to first size bytes.
     Throw exception if something is wrong with filename.
-    Can be also implemented with bash one-liner (assuming size%1024==0):
-    dd if=filename bs=1024 count=size/1024 | sha1sum -
+    Can be also implemented with bash one-liner (assuming ``size%1024==0``)::
+
+        dd if=filename bs=1024 count=size/1024 | sha1sum -
 
     :param filename: Path of the file that will have its hash calculated.
     :param method: Method used to calculate the hash. Supported methods:
-            - md5
-            - sha1
+                   * md5
+                   * sha1
     :param size: If provided, hash only the first size bytes of the file.
     :return: Hash of the file, if something goes wrong, return None.
     """

avocado/utils/memory.py

@@ -211,16 +211,21 @@ def read_from_numa_maps(pid, key):
 
 def get_buddy_info(chunk_sizes, nodes="all", zones="all"):
     """
-    Get the fragement status of the host. It use the same method
-    to get the page size in buddyinfo.
-    2^chunk_size * page_size
+    Get the fragement status of the host.
+
+    It uses the same method to get the page size in buddyinfo. The expression
+    to evaluate it is::
+
+        2^chunk_size * page_size
+
     The chunk_sizes can be string make up by all orders that you want to check
-    splited with blank or a mathematical expression with '>', '<' or '='.
+    splited with blank or a mathematical expression with ``>``, ``<`` or ``=``.
+
     For example:
-    The input of chunk_size could be: "0 2 4"
-    And the return  will be: {'0': 3, '2': 286, '4': 687}
-    if you are using expression: ">=9"
-    the return will be: {'9': 63, '10': 225}
+        * The input of chunk_size could be: ``0 2 4``, and the return  will be
+          ``{'0': 3, '2': 286, '4': 687}``
+        * If you are using expression: ``>=9`` the return will be
+          ``{'9': 63, '10': 225}``
 
     :param chunk_size: The order number shows in buddyinfo. This is not
                        the real page size.

docs/source/conf.py

@@ -103,6 +103,8 @@ pygments_style = 'sphinx'
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
+# Display documentation for __init__ methods
+autoclass_content = 'both'
 
 # -- Options for HTML output ---------------------------------------------------