From: Cédric Ollivier <cedric.ollivier@orange.com>
Date: Fri, 14 Apr 2017 13:27:42 +0000 (+0200)
Subject: Add class attribute docstrings in testcase.py
X-Git-Tag: opnfv-5.0.RC1~472^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=318fd1e4e8f4670f5829f72c53151357d47e30a6;p=functest.git

Add class attribute docstrings in testcase.py

Change-Id: I91a5c6fb14f7c76a348bb4329d023bab53a3804c
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
---

diff --git a/functest/core/testcase.py b/functest/core/testcase.py
index 3b43aefb3..c3fbe1a03 100644
--- a/functest/core/testcase.py
+++ b/functest/core/testcase.py
@@ -21,9 +21,16 @@ class TestCase(object):
     """Parent class of Functest TestCase."""
 
     EX_OK = os.EX_OK
+    """Status code returned when everything is OK"""
+
     EX_RUN_ERROR = os.EX_SOFTWARE
+    """Status code returned when run() fails"""
+
     EX_PUSH_TO_DB_ERROR = os.EX_SOFTWARE - 1
+    """Status code returned when push_to_db() fails"""
+
     EX_TESTCASE_FAILED = os.EX_SOFTWARE - 2
+    """Status code returned when results are false"""
 
     logger = ft_logger.Logger(__name__).getLogger()