openstack/nova
Code Issues Proposed changes

Fix description of parameters in nova functions

Browse Source 
Resolved issues in nova code like
Function 'func_name' does not have a parameter 'param_name'

TrivialFix

Change-Id: Ie83f1eb31a0ce781430dc5a969dd52ac1f00a70c
This commit is contained in:
pkholkin 2015-01-30 15:41:27 +04:00
parent f62459e797
commit ee32a384ad
14 changed files with 23 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
nova/compute/api.py
View File

@ -2463,8 +2463,8 @@ class API(base.Base):
in the resize cycle.
:param context: the request context
:param new_instance_type: the target instance type
:param old_instance_type: the original instance type
:param new_flavor: the target instance type
:param old_flavor: the original instance type
:param sense: the sense of the adjustment, 1 indicates a
forward adjustment, whereas -1 indicates a
reversal of a prior adjustment

5
nova/compute/manager.py
View File

@ -4897,7 +4897,8 @@ class ComputeManager(manager.Manager):
def check_instance_shared_storage(self, ctxt, instance, data):
"""Check if the instance files are shared
:param context: security context
:param ctxt: security context
:param instance: dict of instance data
:param data: result of driver.check_instance_shared_storage_local
Returns True if instance disks located on shared storage and
@ -4947,7 +4948,7 @@ class ComputeManager(manager.Manager):
This checks if the live migration can succeed, based on the
results from check_can_live_migrate_destination.
:param context: security context
:param ctxt: security context
:param instance: dict of instance data
:param dest_check_data: result of check_can_live_migrate_destination
:returns: a dict containing migration info

4
nova/compute/rpcapi.py
View File

@ -308,7 +308,7 @@ class ComputeAPI(object):
'''Add aggregate host.
:param ctxt: request context
:param aggregate_id:
:param aggregate:
:param host_param: This value is placed in the message to be the 'host'
parameter for the remote method.
:param host: This is the host to send the message to.
@ -648,7 +648,7 @@ class ComputeAPI(object):
'''Remove aggregate host.
:param ctxt: request context
:param aggregate_id:
:param aggregate:
:param host_param: This value is placed in the message to be the 'host'
parameter for the remote method.
:param host: This is the host to send the message to.

2
nova/compute/vm_mode.py
View File

@ -38,7 +38,7 @@ ALL = [HVM, XEN, UML, EXE]
def get_from_instance(instance):
"""Get the vm mode for an instance
:param name: instance object to query
:param instance: instance object to query
:returns: canonicalized vm mode for the instance
"""

4
nova/db/sqlalchemy/api.py
View File

@ -2530,7 +2530,6 @@ def instance_info_cache_get(context, instance_uuid):
"""Gets an instance info cache from the table.
:param instance_uuid: = uuid of the info cache's instance
:param session: = optional session object
"""
return model_query(context, models.InstanceInfoCache).\
filter_by(instance_uuid=instance_uuid).\
@ -2543,7 +2542,6 @@ def instance_info_cache_update(context, instance_uuid, values):
:param instance_uuid: = uuid of info cache's instance
:param values: = dict containing column values to update
:param session: = optional session object
"""
session = get_session()
with session.begin():
@ -2576,7 +2574,6 @@ def instance_info_cache_delete(context, instance_uuid):
"""Deletes an existing instance_info_cache record
:param instance_uuid: = uuid of the instance tied to the cache record
:param session: = optional session object
"""
model_query(context, models.InstanceInfoCache).\
filter_by(instance_uuid=instance_uuid).\
@ -3294,7 +3291,6 @@ def _create_quota_usage_if_missing(user_usages, resource, until_refresh,
:param resource: The resource being checked for quota usage.
:param until_refresh: Count of reservations until usage is refreshed,
int or None
:param max_age: Number of seconds between subsequent usage refreshes.
:param project_id: The project being checked for quota usage.
:param user_id: The user being checked for quota usage.
:param session: DB session holding a transaction lock.

2
nova/image/api.py
View File

@ -44,7 +44,7 @@ class API(object):
"""Returns a client session that can be used to query for image
information.
:param context: The `nova.context.Context` object for the request
:param _context: The `nova.context.Context` object for the request
"""
# TODO(jaypipes): Refactor glance.get_remote_image_service and
# glance.get_default_image_service into a single

4
nova/notifications.py
View File

@ -65,8 +65,8 @@ def notify_decorator(name, fn):
"""Decorator for notify which is used from utils.monkey_patch().
:param name: name of the function
:param function: - object of the function
:returns: function -- decorated function
:param fn: - object of the function
:returns: fn -- decorated function
"""
def wrapped_func(*args, **kwarg):

4
nova/openstack/common/report/guru_meditation_report.py
View File

@ -114,7 +114,7 @@ class GuruMeditation(object):
:param version: the version object for the current product
:param service_name: this program name used to construct logfile name
:param logdir: path to a log directory where to create a file
:param log_dir: path to a log directory where to create a file
:param signum: the signal to associate with running the report
"""
@ -142,7 +142,7 @@ class GuruMeditation(object):
:param version: the version object for the current product
:param service_name: this program name used to construct logfile name
:param logdir: path to a log directory where to create a file
:param log_dir: path to a log directory where to create a file
:param traceback: the traceback provided to the signal handler
"""

1
nova/quota.py
View File

@ -1208,7 +1208,6 @@ class QuotaEngine(object):
the given user or project.
:param context: The request context, for access checks.
:param resources: A dictionary of the registered resources.
:param project_id: The ID of the project to return quotas for.
:param user_id: The ID of the user to return quotas for.
"""

6
nova/virt/disk/api.py
View File

@ -636,9 +636,9 @@ def _set_passwd(username, admin_passwd, passwd_data, shadow_data):
if the username is not found in both files, an exception is raised.
:param username: the username
:param encrypted_passwd: the encrypted password
:param passwd_file: path to the passwd file
:param shadow_file: path to the shadow password file
:param admin_passwd: the admin password
:param passwd_data: path to the passwd file
:param shadow_data: path to the shadow password file
:returns: nothing
:raises: exception.NovaException(), IOError()

4
nova/virt/driver.py
View File

@ -963,7 +963,7 @@ class ComputeDriver(object):
"""Set the root password on the specified instance.
:param instance: nova.objects.instance.Instance
:param new_password: the new password
:param new_pass: the new password
"""
raise NotImplementedError()
@ -1154,7 +1154,7 @@ class ComputeDriver(object):
related to other calls into the driver. The prime example is to clean
the cache and remove images which are no longer of interest.
:param instances: nova.objects.instance.InstanceList
:param all_instances: nova.objects.instance.InstanceList
"""
pass

4
nova/virt/hardware.py
View File

@ -646,13 +646,13 @@ class VirtNUMATopologyCellLimit(VirtNUMATopologyCell):
:param cpuset: set containing list of CPU indexes
:param memory: RAM measured in MiB
:param cpu_limit: maximum number of CPUs allocated
:param memory_usage: maxumum RAM allocated in MiB
:param memory_limit: maxumum RAM allocated in MiB
Creates a new NUMA cell object to represent the max hardware
resources and utilization. The number of CPUs specified
by the @cpu_usage parameter may be larger than the number
of bits set in @cpuset if CPU overcommit is used. Likewise
the amount of RAM specified by the @memory_usage parameter
the amount of RAM specified by the @memory_limit parameter
may be larger than the available RAM in @memory if RAM
overcommit is used.

2
nova/virt/xenapi/driver.py
View File

@ -490,7 +490,7 @@ class XenAPIDriver(driver.ComputeDriver):
"""Do required cleanup on dest host after check_can_live_migrate calls
:param context: security context
:param disk_over_commit: if true, allow disk over commit
:param dest_check_data: result of check_can_live_migrate_destination
"""
pass

4
nova/virt/xenapi/vmops.py
View File

@ -2071,7 +2071,7 @@ class VMOps(object):
disk_over_commit=False):
"""Check if it is possible to execute live migration.
:param context: security context
:param ctxt: security context
:param instance_ref: nova.db.sqlalchemy.models.Instance object
:param block_migration: if true, prepare for block migration
:param disk_over_commit: if true, allow disk over commit
@ -2111,7 +2111,7 @@ class VMOps(object):
dest_check_data):
"""Check if it's possible to execute live migration on the source side.
:param context: security context
:param ctxt: security context
:param instance_ref: nova.db.sqlalchemy.models.Instance object
:param dest_check_data: data returned by the check on the
destination, includes block_migration flag