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: Ic59822cb8e9a43ce83e6e59f002f28ffea89d935
This commit is contained in:
Duan Jiong 2017-03-23 09:13:09 +08:00
parent 9db0fe2a8e
commit e5744b2f14
5 changed files with 8 additions and 8 deletions

View File

@ -144,7 +144,7 @@ def is_supported(req, min_version=_MIN_API_VERSION,
:param max_version: maximum version of API needed for correct
request processing
:returns True if request satisfies minimal and maximum API version
:returns: True if request satisfies minimal and maximum API version
requirements. False in other case.
"""

View File

@ -116,7 +116,7 @@ class ResourceClassCache(object):
:param rc_id: The numeric representation of the resource class to look
up a string identifier for.
:returns string identifier for the resource class, or None, if no such
:returns: string identifier for the resource class, or None, if no such
resource class was found in the list of standard resource
classes or the resource_classes database table.
:raises `exception.ResourceClassNotFound` if rc_id cannot be found in

View File

@ -901,7 +901,7 @@ def last_bytes(file_like_object, num):
:param file_like_object: The file to read
:param num: The number of bytes to return
:returns (data, remaining)
:returns: (data, remaining)
"""
try:

View File

@ -356,7 +356,7 @@ class ComputeDriver(object):
:param context: security context
:param instance: nova.objects.instance.Instance
:returns an instance of console.type.ConsoleVNC
:returns: an instance of console.type.ConsoleVNC
"""
raise NotImplementedError()
@ -366,7 +366,7 @@ class ComputeDriver(object):
:param context: security context
:param instance: nova.objects.instance.Instance
:returns an instance of console.type.ConsoleSpice
:returns: an instance of console.type.ConsoleSpice
"""
raise NotImplementedError()
@ -376,7 +376,7 @@ class ComputeDriver(object):
:param context: security context
:param instance: nova.objects.instance.Instance
:returns an instance of console.type.ConsoleRDP
:returns: an instance of console.type.ConsoleRDP
"""
raise NotImplementedError()
@ -386,7 +386,7 @@ class ComputeDriver(object):
:param context: security context
:param instance: nova.objects.instance.Instance
:returns an instance of console.type.ConsoleSerial
:returns: an instance of console.type.ConsoleSerial
"""
raise NotImplementedError()

View File

@ -435,7 +435,7 @@ def _filter_datastores_matching_storage_policy(session, data_stores,
:param data_stores: the list of retrieve result wrapped datastore objects
:param storage_policy: the storage policy name
:return the list of datastores conforming to the given storage policy
:return: the list of datastores conforming to the given storage policy
"""
profile_id = pbm.get_profile_id_by_name(session, storage_policy)
if profile_id: