From d52d16c6e624b84d7f562f6f81092f2b5f4e6dc4 Mon Sep 17 00:00:00 2001 From: Imre Farkas Date: Tue, 8 Dec 2015 14:40:50 +0100 Subject: [PATCH] Fix docstrings for params Change-Id: I95784e65fcaacb7d74a1a6dab0d8549c2a6cf13a --- dracclient/client.py | 46 ++++++++++++++++++------------------ dracclient/resources/bios.py | 6 ++--- dracclient/resources/job.py | 32 ++++++++++++------------- dracclient/utils.py | 6 ++--- 4 files changed, 45 insertions(+), 45 deletions(-) diff --git a/dracclient/client.py b/dracclient/client.py index bc5e518..1ddc0ab 100644 --- a/dracclient/client.py +++ b/dracclient/client.py @@ -139,9 +139,9 @@ class DRACClient(object): attributes passed in. For the values to be applied, a config job must be created and the node must be rebooted. - :param: settings: a dictionary containing the proposed values, with - each key being the name of attribute and the - value being the proposed value. + :param settings: a dictionary containing the proposed values, with + each key being the name of attribute and the value + being the proposed value. :returns: a dictionary containing the commit_needed key with a boolean value indicating whether a config job must be created for the values to be applied. @@ -193,15 +193,15 @@ class DRACClient(object): the instance of the class, on which the CreateTargetedConfigJob method is invoked. - :param: resource_uri: URI of resource to invoke - :param: cim_creation_class_name: creation class name of the CIM object - :param: cim_name: name of the CIM object - :param: target: target device - :param: cim_system_creation_class_name: creation class name of the - scoping system - :param: cim_system_name: name of the scoping system - :param: reboot: indicates whether a RebootJob should be also be - created or not + :param resource_uri: URI of resource to invoke + :param cim_creation_class_name: creation class name of the CIM object + :param cim_name: name of the CIM object + :param target: target device + :param cim_system_creation_class_name: creation class name of the + scoping system + :param cim_system_name: name of the scoping system + :param reboot: indicates whether a RebootJob should be also be + created or not :returns: id of the created job :raises: WSManRequestFailure on request failures :raises: WSManInvalidResponse when receiving invalid response @@ -229,13 +229,13 @@ class DRACClient(object): the instance of the class, on which the CreateTargetedConfigJob method is invoked. - :param: resource_uri: URI of resource to invoke - :param: cim_creation_class_name: creation class name of the CIM object - :param: cim_name: name of the CIM object - :param: target: target device - :param: cim_system_creation_class_name: creation class name of the - scoping system - :param: cim_system_name: name of the scoping system + :param resource_uri: URI of resource to invoke + :param cim_creation_class_name: creation class name of the CIM object + :param cim_name: name of the CIM object + :param target: target device + :param cim_system_creation_class_name: creation class name of the + scoping system + :param cim_system_name: name of the scoping system :raises: WSManRequestFailure on request failures :raises: WSManInvalidResponse when receiving invalid response :raises: DRACOperationFailed on error reported back by the DRAC @@ -249,8 +249,8 @@ class DRACClient(object): def commit_pending_bios_changes(self, reboot=False): """Applies all pending changes on the BIOS by creating a config job - :param: reboot: indicates whether a RebootJob should be also be - created or not + :param reboot: indicates whether a RebootJob should be also be + created or not :returns: id of the created job :raises: WSManRequestFailure on request failures :raises: WSManInvalidResponse when receiving invalid response @@ -374,8 +374,8 @@ class DRACClient(object): ...by creating a config job. - :param: reboot: indicates whether a RebootJob should be also be - created or not + :param reboot: indicates whether a RebootJob should be also be + created or not :returns: id of the created job :raises: WSManRequestFailure on request failures :raises: WSManInvalidResponse when receiving invalid response diff --git a/dracclient/resources/bios.py b/dracclient/resources/bios.py index 6b0dd89..ae4daad 100644 --- a/dracclient/resources/bios.py +++ b/dracclient/resources/bios.py @@ -503,9 +503,9 @@ class BIOSConfiguration(object): attributes passed in. For the values to be applied, a config job must be created and the node must be rebooted. - :param: new_settings: a dictionary containing the proposed values, with - each key being the name of attribute and the - value being the proposed value. + :param new_settings: a dictionary containing the proposed values, with + each key being the name of attribute and the + value being the proposed value. :returns: a dictionary containing the commit_needed key with a boolean value indicating whether a config job must be created for the values to be applied. diff --git a/dracclient/resources/job.py b/dracclient/resources/job.py index c8f1785..0b4fdc9 100644 --- a/dracclient/resources/job.py +++ b/dracclient/resources/job.py @@ -96,15 +96,15 @@ class JobManagement(object): the instance of the class, on which the CreateTargetedConfigJob method is invoked. - :param: resource_uri: URI of resource to invoke - :param: cim_creation_class_name: creation class name of the CIM object - :param: cim_name: name of the CIM object - :param: target: target device - :param: cim_system_creation_class_name: creation class name of the - scoping system - :param: cim_system_name: name of the scoping system - :param: reboot: indicates whether a RebootJob should be also be - created or not + :param resource_uri: URI of resource to invoke + :param cim_creation_class_name: creation class name of the CIM object + :param cim_name: name of the CIM object + :param target: target device + :param cim_system_creation_class_name: creation class name of the + scoping system + :param cim_system_name: name of the scoping system + :param reboot: indicates whether a RebootJob should be also be + created or not :returns: id of the created job :raises: WSManRequestFailure on request failures :raises: WSManInvalidResponse when receiving invalid response @@ -152,13 +152,13 @@ class JobManagement(object): the instance of the class, on which the CreateTargetedConfigJob method is invoked. - :param: resource_uri: URI of resource to invoke - :param: cim_creation_class_name: creation class name of the CIM object - :param: cim_name: name of the CIM object - :param: target: target device - :param: cim_system_creation_class_name: creation class name of the - scoping system - :param: cim_system_name: name of the scoping system + :param resource_uri: URI of resource to invoke + :param cim_creation_class_name: creation class name of the CIM object + :param cim_name: name of the CIM object + :param target: target device + :param cim_system_creation_class_name: creation class name of the + scoping system + :param cim_system_name: name of the scoping system :raises: WSManRequestFailure on request failures :raises: WSManInvalidResponse when receiving invalid response :raises: DRACOperationFailed on error reported back by the DRAC diff --git a/dracclient/utils.py b/dracclient/utils.py index 0f54411..4d2b181 100644 --- a/dracclient/utils.py +++ b/dracclient/utils.py @@ -50,9 +50,9 @@ def get_wsman_resource_attr(doc, resource_uri, attr_name, nullable=False): :param doc: the element tree object. :param resource_uri: the resource URI of the namespace. :param attr_name: the name of the attribute. - :param: nullable: enables checking if the element contains an - XMLSchema-instance namespaced nil attribute that has a - value of True. In this case, it will return None. + :param nullable: enables checking if the element contains an + XMLSchema-instance namespaced nil attribute that has a + value of True. In this case, it will return None. :returns: value of the attribute """ item = find_xml(doc, attr_name, resource_uri)