openstack/ironic
Code Issues Proposed changes

Cleans up some Sphinx rST warnings in Ironic

Browse Source 
The names of parameters in docstrings should not have leading astrisk
characters, because it confuses the rST parser.

Change-Id: I8c3574b03903a23c10ef2afcb793c6766a486007
Partial-Bug: 1277282
This commit is contained in:
Mark Atwood 2014-10-01 06:58:10 +00:00
parent 0827173215
commit 56fed1198f
5 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ironic/api/controllers/v1/types.py
View File

@ -156,7 +156,7 @@ class MultiType(wtypes.UserType):
Used for validating that a value is an instance of one of the types.
:param *types: Variable-length list of types.
:param types: Variable-length list of types.
"""
def __init__(self, *types):

4
ironic/conductor/task_manager.py
View File

@ -205,8 +205,8 @@ class TaskManager(object):
:param _on_error_method: a callable object, it's first parameter
should accept the Exception object that was raised.
:param *args: additional args passed to the callable object.
:param **kwargs: additional kwargs passed to the callable object.
:param args: additional args passed to the callable object.
:param kwargs: additional kwargs passed to the callable object.
"""
self._on_error_method = _on_error_method

4
ironic/drivers/base.py
View File

@ -378,7 +378,7 @@ class VendorInterface(object):
:param kwargs: info for action.
:raises: UnsupportedDriverExtension if 'method' can not be mapped to
the supported interfaces.
:raises: InvalidParameterValue if **kwargs does not contain 'method'.
:raises: InvalidParameterValue if kwargs does not contain 'method'.
:raises: MissingParameterValue
"""
@ -391,7 +391,7 @@ class VendorInterface(object):
:raises: UnsupportedDriverExtension if 'method' can not be mapped to
the supported interfaces.
:raises: InvalidParameterValue if **kwargs does not contain 'method'.
:raises: InvalidParameterValue if kwargs does not contain 'method'.
:raises: MissingParameterValue when a required parameter is missing
"""

2
ironic/drivers/modules/ipmitool.py
View File

@ -868,7 +868,7 @@ class VendorPassthru(base.VendorInterface):
:param task: a task from TaskManager.
:param kwargs: info for action.
:raises: InvalidParameterValue if **kwargs does not contain 'method',
:raises: InvalidParameterValue if kwargs does not contain 'method',
'method' is not supported or a byte string is not given for
'raw_bytes'.
:raises: MissingParameterValue if a required parameter is missing.

4
ironic/drivers/utils.py
View File

@ -69,7 +69,7 @@ class MixinVendorInterface(base.VendorInterface):
:raises: UnsupportedDriverExtension if 'method' can not be mapped to
the supported interfaces.
:raises: InvalidParameterValue if **kwargs does not contain 'method'.
:raises: InvalidParameterValue if kwargs does not contain 'method'.
:raisee: MissingParameterValue if missing parameters in kwargs.
"""
@ -83,7 +83,7 @@ class MixinVendorInterface(base.VendorInterface):
:raises: UnsupportedDriverExtension if 'method' can not be mapped to
the supported interfaces.
:raises: MissingParameterValue if **kwargs does not contain 'method'.
:raises: MissingParameterValue if kwargs does not contain 'method'.
"""
route = self._map(**kwargs)