diff options
author | Serena Feng <feng.xiaowei@zte.com.cn> | 2017-04-21 09:05:15 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@opnfv.org> | 2017-04-21 09:05:15 +0000 |
commit | 96481540320550457181696c43a0e2fa34b9273d (patch) | |
tree | 0e8eda5e60cdae66147c4cba862c287397d2354b /functest/core/feature.py | |
parent | eeafc7d012079bc3ff64d28bc65e0051ad2cf46e (diff) | |
parent | 9b36d7fcfdbe45cd90723a6153863e4789d650cf (diff) |
Merge "Minor changes in docstrings"
Diffstat (limited to 'functest/core/feature.py')
-rw-r--r-- | functest/core/feature.py | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/functest/core/feature.py b/functest/core/feature.py index 00c7ec74..d8ddbdeb 100644 --- a/functest/core/feature.py +++ b/functest/core/feature.py @@ -25,7 +25,7 @@ __author__ = ("Serena Feng <feng.xiaowei@zte.com.cn>, " class Feature(base.TestCase): - """Parent class of Functest Feature.""" + """Base model for single Functest feature.""" def __init__(self, **kwargs): super(Feature, self).__init__(**kwargs) @@ -34,11 +34,13 @@ class Feature(base.TestCase): self.logger = ft_logger.Logger(self.project_name).getLogger() def execute(self, **kwargs): - """Execute Feature. + """Execute the Python method. The subclasses must override the default implementation which - is false on purpose. The only prerequisite is to return 0 if - success or anything else if failure. + is false on purpose. + + The new implementation must return 0 if success or anything + else if failure. Args: kwargs: Arbitrary keyword arguments. @@ -50,7 +52,7 @@ class Feature(base.TestCase): return -1 def run(self, **kwargs): - """Run Feature. + """Run the feature. It allows executing any Python method by calling execute(). |