From 811e6a0eacfe856745dcee55545cd8cb2a39e816 Mon Sep 17 00:00:00 2001 From: =?utf8?q?C=C3=A9dric=20Ollivier?= Date: Mon, 5 Feb 2018 17:13:53 +0100 Subject: [PATCH] Fix docstrings MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Else sphinx can't parse snaps_suite_builder.py and IxRestUtils.py. Change-Id: Iab231a043120154bce708263474b9f9926c1f715 Signed-off-by: Cédric Ollivier --- functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py | 3 +++ functest/opnfv_tests/vnf/ims/ixia/utils/IxRestUtils.py | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py b/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py index ab7b368fd..ed3b2825e 100644 --- a/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py +++ b/functest/opnfv_tests/openstack/snaps/snaps_suite_builder.py @@ -84,6 +84,7 @@ def add_openstack_client_tests(suite, os_creds, ext_net_name, use_keystone=True, log_level=logging.INFO): """ Adds tests written to exercise OpenStack client retrieval + :param suite: the unittest.TestSuite object to which to add the tests :param os_creds: and instance of OSCreds that holds the credentials required by OpenStack @@ -130,6 +131,7 @@ def add_openstack_api_tests(suite, os_creds, ext_net_name, use_keystone=True, # pylint: disable=too-many-arguments """ Adds tests written to exercise all existing OpenStack APIs + :param suite: the unittest.TestSuite object to which to add the tests :param os_creds: Instance of OSCreds that holds the credentials required by OpenStack @@ -246,6 +248,7 @@ def add_openstack_integration_tests(suite, os_creds, ext_net_name, Adds tests written to exercise all long-running OpenStack integration tests meaning they will be creating VM instances and potentially performing some SSH functions through floatingIPs + :param suite: the unittest.TestSuite object to which to add the tests :param os_creds: and instance of OSCreds that holds the credentials required by OpenStack diff --git a/functest/opnfv_tests/vnf/ims/ixia/utils/IxRestUtils.py b/functest/opnfv_tests/vnf/ims/ixia/utils/IxRestUtils.py index 63db403b3..41c23dc53 100644 --- a/functest/opnfv_tests/vnf/ims/ixia/utils/IxRestUtils.py +++ b/functest/opnfv_tests/vnf/ims/ixia/utils/IxRestUtils.py @@ -76,6 +76,7 @@ class Connection(object): Use this instead of urlparse.urljoin directly so that we can customize its behavior if necessary. Currently differs in that it + 1. appends a / to base if not present. 2. casts end to a str as a convenience """ @@ -186,7 +187,7 @@ class WebObject(object): def getOptions(self): ''' - Get the JSON dictionary which represents the WebObject Instance + Get the JSON dictionary which represents the WebObject Instance ''' return self.jsonOptions -- 2.16.6