From 56fed1198fd42953f827521748c6be475d9f4fa4 Mon Sep 17 00:00:00 2001 From: Mark Atwood Date: Wed, 1 Oct 2014 06:58:10 +0000 Subject: [PATCH] Cleans up some Sphinx rST warnings in Ironic The names of parameters in docstrings should not have leading astrisk characters, because it confuses the rST parser. Change-Id: I8c3574b03903a23c10ef2afcb793c6766a486007 Partial-Bug: 1277282 --- ironic/api/controllers/v1/types.py | 2 +- ironic/conductor/task_manager.py | 4 ++-- ironic/drivers/base.py | 4 ++-- ironic/drivers/modules/ipmitool.py | 2 +- ironic/drivers/utils.py | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/ironic/api/controllers/v1/types.py b/ironic/api/controllers/v1/types.py index 31eb4cb72a..aa9c9c6d7e 100644 --- a/ironic/api/controllers/v1/types.py +++ b/ironic/api/controllers/v1/types.py @@ -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): diff --git a/ironic/conductor/task_manager.py b/ironic/conductor/task_manager.py index a8321bb1ae..79e4d6d308 100644 --- a/ironic/conductor/task_manager.py +++ b/ironic/conductor/task_manager.py @@ -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 diff --git a/ironic/drivers/base.py b/ironic/drivers/base.py index 520069b77e..ea2c075033 100644 --- a/ironic/drivers/base.py +++ b/ironic/drivers/base.py @@ -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 """ diff --git a/ironic/drivers/modules/ipmitool.py b/ironic/drivers/modules/ipmitool.py index 9333ac51e7..5cc60a58d1 100644 --- a/ironic/drivers/modules/ipmitool.py +++ b/ironic/drivers/modules/ipmitool.py @@ -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. diff --git a/ironic/drivers/utils.py b/ironic/drivers/utils.py index edaa84b1e7..64fbfe06e6 100644 --- a/ironic/drivers/utils.py +++ b/ironic/drivers/utils.py @@ -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)