openstack/openstack-ansible-ops
Code Issues Proposed changes

Fix :param: in docstring

Browse Source 
:param should be used in docstring instead of :param:.

Change-Id: Ife417efb9d5741c6f0546b60906fa02ce2a2f92b
This commit is contained in:
zhufl 2019-06-17 10:38:59 +08:00
parent cdb1e34a35
commit 4fded62ffa
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
bowling_ball/rolling_tests.py
View File

@ -60,13 +60,13 @@ class ServiceTest(object):
def configure_logger(self, logger, console_logging=False): def configure_logger(self, logger, console_logging=False):
"""Configure a stream and file log for a given service """Configure a stream and file log for a given service
:param: service - name of service for log file. :param service: name of service for log file.
generates `/var/log/{service_name}_query.log` generates `/var/log/{service_name}_query.log`
:param: logger - logger to be configure for the test. :param logger: logger to be configure for the test.
Filename will be based on the test's `service_name` Filename will be based on the test's `service_name`
property property
:param: console_logging - flag controlling whether or not a console :param console_logging: flag controlling whether or not a console
logger is used logger is used
""" """
logger.setLevel(logging.INFO) logger.setLevel(logging.INFO)
filename = '/var/log/{}_rolling.log'.format(self.service_name) filename = '/var/log/{}_rolling.log'.format(self.service_name)
@ -103,10 +103,10 @@ class ServiceTest(object):
This applies to high level concepts like 'flavors', 'networks', This applies to high level concepts like 'flavors', 'networks',
'subnets', etc. 'subnets', etc.
:params: service - an openstack service corresponding to the OpenStack :params service: an openstack service corresponding to the OpenStack
SDK module used, such as 'compute', 'network', etc. SDK module used, such as 'compute', 'network', etc.
:param: name - name of a type of object, such as a 'network', :param name: name of a type of object, such as a 'network',
'server', 'volume', etc owned by an OpenStack service 'server', 'volume', etc owned by an OpenStack service
""" """
objs = [obj for obj in getattr(getattr(self.conn, service), name)()] objs = [obj for obj in getattr(getattr(self.conn, service), name)()]
@ -253,8 +253,8 @@ class TestRunner(object):
Execution can be ended by sending SIGINT or SIGTERM and the running Execution can be ended by sending SIGINT or SIGTERM and the running
test will finish. test will finish.
:param: test - on object that performs some action :param test: on object that performs some action
against an OpenStack service API. against an OpenStack service API.
""" """
disconnected = None disconnected = None
while True: while True: