From 408543378135dda5a17998ef1cf3a37bd8c79df4 Mon Sep 17 00:00:00 2001 From: XieYingYun Date: Tue, 28 Mar 2017 19:46:08 +0800 Subject: [PATCH] Fix some reST field lists in docstrings Probably the most common format for documenting arguments is reST field lists [1]. This change updates some docstrings to comply with the field lists syntax. [1] http://sphinx-doc.org/domains.html#info-field-lists Change-Id: If115f76d6f26108e55fb3460f36283f943ee61fb --- octavia/tests/tempest/common/manager.py | 4 ++-- octavia/tests/tempest/v1/scenario/base.py | 2 +- octavia/tests/tempest/v2/scenario/base.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/octavia/tests/tempest/common/manager.py b/octavia/tests/tempest/common/manager.py index 73da18229b..a6ff14edbe 100644 --- a/octavia/tests/tempest/common/manager.py +++ b/octavia/tests/tempest/common/manager.py @@ -579,7 +579,7 @@ class ScenarioTest(tempest.test.BaseTestCase): negative - attempt ping and fail if succeed :param mtu: network MTU to use for connectivity validation - :raises: AssertError if the result of the connectivity check does + :raises AssertError: if the result of the connectivity check does not match the value of the should_connect param """ if should_connect: @@ -881,7 +881,7 @@ class NetworkScenarioTest(ScenarioTest): :param dict floating_ip: floating IP dict to check status :param status: target status - :raises: AssertionError if status doesn't match + :raises AssertionError: if status doesn't match """ floatingip_id = floating_ip['id'] diff --git a/octavia/tests/tempest/v1/scenario/base.py b/octavia/tests/tempest/v1/scenario/base.py index 8d0c448bba..a2ce0f3f60 100644 --- a/octavia/tests/tempest/v1/scenario/base.py +++ b/octavia/tests/tempest/v1/scenario/base.py @@ -424,7 +424,7 @@ class BaseTestCase(manager.NetworkScenarioTest): :param dict floating_ip: floating IP dict to check status :param status: target status - :raises: AssertionError if status doesn't match + :raises AssertionError: if status doesn't match """ # TODO(ptoohill): Find a way to utilze the proper client method diff --git a/octavia/tests/tempest/v2/scenario/base.py b/octavia/tests/tempest/v2/scenario/base.py index 7669f38f6a..81ad0a3010 100644 --- a/octavia/tests/tempest/v2/scenario/base.py +++ b/octavia/tests/tempest/v2/scenario/base.py @@ -415,7 +415,7 @@ class BaseTestCase(manager.NetworkScenarioTest): :param dict floating_ip: floating IP dict to check status :param status: target status - :raises: AssertionError if status doesn't match + :raises AssertionError: if status doesn't match """ # TODO(ptoohill): Find a way to utilze the proper client method