Merge "Fix some reST field lists in docstrings"

This commit is contained in:
Jenkins 2017-04-11 23:01:29 +00:00 committed by Gerrit Code Review
commit 4f049ab0bc
6 changed files with 8 additions and 8 deletions

View File

@ -163,7 +163,7 @@ def parse_image_ref(image_href):
:param image_href: href of an image
:returns: a tuple of the form (image_id, host, port, use_ssl)
:raises ValueError
:raises ValueError: when input image href is invalid
"""
if '/' not in six.text_type(image_href):
image_id = image_href

View File

@ -461,7 +461,7 @@ def is_whole_disk_image(ctx, instance_info):
:param ctx: an admin context
:param instance_info: a node's instance info dict
:returns True for whole disk images and False for partition images
:returns: True for whole disk images and False for partition images
and None on no image_source or Error.
"""
image_source = instance_info.get('image_source')

View File

@ -1186,7 +1186,7 @@ def _validate_argsinfo(argsinfo):
required: Boolean. Optional; default is False. True if this
argument is required. If so, it must be specified in
the clean request; false if it is optional.
:raises InvalidParameterValue if any of the arguments are invalid
:raises InvalidParameterValue: if any of the arguments are invalid
"""
if not argsinfo:
return
@ -1280,7 +1280,7 @@ def clean_step(priority, abortable=False, argsinfo=None):
required: Boolean. Optional; default is False. True if this
argument is required. If so, it must be specified in
the clean request; false if it is optional.
:raises InvalidParameterValue if any of the arguments are invalid
:raises InvalidParameterValue: if any of the arguments are invalid
"""
def decorator(func):
func._is_clean_step = True

View File

@ -266,9 +266,9 @@ def _parse_snmp_driver_info(info):
:param info: driver_info dictionary.
:returns: a dictionary containing SNMP information.
:raises exception.MissingParameterValue if any of the mandatory
:raises exception.MissingParameterValue: if any of the mandatory
parameter values are not provided.
:raises exception.InvalidParameterValue if the value provided
:raises exception.InvalidParameterValue: if the value provided
for SNMP_OPTIONAL_PROPERTIES has an invalid value.
"""
snmp_info = {}

View File

@ -145,7 +145,7 @@ def _get_capabilities(node, ilo_object):
:param node: Node object.
:param ilo_object: an instance of ilo drivers.
:returns : a string of capabilities like
:returns: a string of capabilities like
'key1:value1,key2:value2,key3:value3'
or None.

View File

@ -118,7 +118,7 @@ def get_oneview_info(node):
:enclosure_group_uri: the uri of the enclosure group in OneView
:server_profile_template_uri: the uri of the server profile template in
OneView
:raises OneViewInvalidNodeParameter if node capabilities are malformed
:raises OneViewInvalidNodeParameter: if node capabilities are malformed
"""
try: