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
This commit is contained in:
XieYingYun 2017-03-28 19:46:08 +08:00
parent 3eedc728f1
commit 4085433781
3 changed files with 4 additions and 4 deletions

View File

@ -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']

View File

@ -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

View File

@ -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