openstack/ironic
Code Issues Proposed changes

Fix :param: in docstring

Browse Source 
In docstring :param should be used instead of :param:.

Change-Id: Id531e58087b8196b30dda12aa4245a1eefd638ac
This commit is contained in:
zhu.fanglei 2019-06-14 11:45:11 +08:00
parent 7d204b6568
commit 43f7bf9f0b
6 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -370,7 +370,7 @@ def is_valid_node_name(name):
Check to see that the provided node name is valid, and isn't a UUID.
:param: name: the node name to check.
:param name: the node name to check.
:returns: True if the name is valid, False otherwise.
"""
return is_valid_logical_name(name) and not uuidutils.is_uuid_like(name)

10
ironic/cmd/dbsync.py
View File

@ -169,10 +169,10 @@ class DBCommand(object):
specified max_count. A migration of an object will typically migrate
one row of data inside the database.
:param: context: an admin context
:param: max_count: the maximum number of objects (rows) to migrate;
:param context: an admin context
:param max_count: the maximum number of objects (rows) to migrate;
a value >= 1.
:param: options: migration options - dict mapping migration name
:param options: migration options - dict mapping migration name
to a dictionary of options for this migration.
:raises: Exception from the migration function
:returns: Boolean value indicating whether migrations are done. Returns
@ -226,10 +226,10 @@ class DBCommand(object):
migrations are done. Otherwise, this will run (some of) the functions
until max_count objects have been migrated.
:param: max_count: the maximum number of individual object migrations
:param max_count: the maximum number of individual object migrations
or modified rows, a value >= 1. If None, migrations are run in a
loop in batches of 50, until completion.
:param: options: options to pass to migrations. List of values in the
:param options: options to pass to migrations. List of values in the
form of <migration name>.<option>=<value>
:raises: SystemExit. With exit code of:
0: when all migrations are complete.

4
ironic/common/images.py
View File

@ -530,8 +530,8 @@ def is_whole_disk_image(ctx, instance_info):
def _mount_deploy_iso(deploy_iso, mountdir):
"""This function opens up the deploy iso used for deploy.
:param: deploy_iso: path to the deploy iso where its
contents are fetched to.
:param deploy_iso: path to the deploy iso where its
contents are fetched to.
:raises: ImageCreationFailed if mount fails.
:returns: a tuple consisting of - 1. a dictionary containing
the values as required

48
ironic/conductor/base_manager.py
View File

@ -446,29 +446,29 @@ class BaseConductorManager(object):
in whatever provisioning activity it was currently doing.
That failure is processed here.
:param: context: request context
:param: filters: criteria (as a dictionary) to get the desired
list of nodes that satisfy the filter constraints.
For example, if filters['provisioned_before'] = 60,
this would process nodes whose provision_updated_at
field value was 60 or more seconds before 'now'.
:param: provision_state: provision_state that the node is in,
for the provisioning activity to have failed,
either one string or a set.
:param: sort_key: the nodes are sorted based on this key.
:param: callback_method: the callback method to be invoked in a
spawned thread, for a failed node. This
method must take a :class:`TaskManager` as
the first (and only required) parameter.
:param: err_handler: for a failed node, the error handler to invoke
if an error occurs trying to spawn an thread
to do the callback_method.
:param: last_error: the error message to be updated in node.last_error
:param: keep_target_state: if True, a failed node will keep the same
target provision state it had before the
failure. Otherwise, the node's target
provision state will be determined by the
fsm.
:param context: request context
:param filters: criteria (as a dictionary) to get the desired
list of nodes that satisfy the filter constraints.
For example, if filters['provisioned_before'] = 60,
this would process nodes whose provision_updated_at
field value was 60 or more seconds before 'now'.
:param provision_state: provision_state that the node is in,
for the provisioning activity to have failed,
either one string or a set.
:param sort_key: the nodes are sorted based on this key.
:param callback_method: the callback method to be invoked in a
spawned thread, for a failed node. This
method must take a :class:`TaskManager` as
the first (and only required) parameter.
:param err_handler: for a failed node, the error handler to invoke
if an error occurs trying to spawn an thread
to do the callback_method.
:param last_error: the error message to be updated in node.last_error
:param keep_target_state: if True, a failed node will keep the same
target provision state it had before the
failure. Otherwise, the node's target
provision state will be determined by the
fsm.
"""
if isinstance(provision_state, six.string_types):
@ -512,7 +512,7 @@ class BaseConductorManager(object):
def _start_consoles(self, context):
"""Start consoles if set enabled.
:param: context: request context
:param context: request context
"""
filters = {'console_enabled': True}

6
ironic/conductor/manager.py
View File

@ -3115,7 +3115,7 @@ class ConductorManager(base_manager.BaseConductorManager):
def _check_inspect_wait_timeouts(self, context):
"""Periodically checks inspect_wait_timeout and fails upon reaching it.
:param: context: request context
:param context: request context
"""
# FIXME(rloo): If the value is < 0, it will be enabled. That doesn't
@ -4112,8 +4112,8 @@ def do_sync_power_state(task, count):
def _do_inspect_hardware(task):
"""Initiates inspection.
:param: task: a TaskManager instance with an exclusive lock
on its node.
:param task: a TaskManager instance with an exclusive lock
on its node.
:raises: HardwareInspectionFailure if driver doesn't
return the state as states.MANAGEABLE, states.INSPECTWAIT.

6
ironic/drivers/modules/xclarity/common.py
View File

@ -134,7 +134,7 @@ def get_server_hardware_id(node):
Validates whether node configutation is consistent with XClarity and
returns the XClarity Hardware ID for a specific node.
:param: node: node object to get information from
:param node: node object to get information from
:returns: the XClarity Hardware ID for a specific node
:raises: MissingParameterValue if unable to validate XClarity Hardware ID
@ -151,7 +151,7 @@ def get_server_hardware_id(node):
def translate_xclarity_power_state(power_state):
"""Translates XClarity's power state strings to be consistent with Ironic.
:param: power_state: power state string to be translated
:param power_state: power state string to be translated
:returns: the translated power state
"""
power_states_map = {
@ -165,7 +165,7 @@ def translate_xclarity_power_state(power_state):
def translate_xclarity_power_action(power_action):
"""Translates ironic's power action strings to XClarity's format.
:param: power_action: power action string to be translated
:param power_action: power action string to be translated
:returns: the power action translated
"""