From 53c480ff07f435b69bdc634659df99643aeb0e14 Mon Sep 17 00:00:00 2001 From: Rafael Rivero Date: Wed, 24 Sep 2014 13:15:41 -0700 Subject: [PATCH] Fixes docstring typos (Cinder) A few more typographical errors found in Cinder docstrings. Change-Id: If841350592650e23e9d7b24b4c52a3cdddb62d2f --- cinder/scheduler/simple.py | 2 +- cinder/tests/api/v1/test_limits.py | 4 ++-- cinder/tests/db/test_qos_specs.py | 2 +- cinder/tests/image/test_glance.py | 2 +- cinder/tests/test_pure.py | 4 ++-- cinder/volume/driver.py | 2 +- cinder/volume/drivers/emc/emc_cli_fc.py | 2 +- cinder/volume/drivers/emc/emc_vmax_common.py | 4 ++-- cinder/volume/drivers/emc/emc_vmax_fast.py | 2 +- cinder/volume/drivers/emc/emc_vmax_masking.py | 6 +++--- cinder/volume/drivers/emc/emc_vnx_cli.py | 2 +- cinder/volume/drivers/hds/iscsi.py | 2 +- cinder/volume/drivers/san/hp/hp_msa_common.py | 2 +- cinder/volume/drivers/solidfire.py | 2 +- cinder/volume/drivers/zfssa/restclient.py | 2 +- 15 files changed, 20 insertions(+), 20 deletions(-) diff --git a/cinder/scheduler/simple.py b/cinder/scheduler/simple.py index 2dd59015e..7414f5736 100644 --- a/cinder/scheduler/simple.py +++ b/cinder/scheduler/simple.py @@ -31,7 +31,7 @@ of filters and weighers. scheduler_default_weighers = 'ChanceWeigher' If one prefers the scheduler to pick up the back-end has most available -space that scheudler can see (like SimpleScheduler did), use following +space that scheduler can see (like SimpleScheduler did), use following combination of filters and weighers with FilterScheduler. scheduler_driver = cinder.scheduler.filter_scheduler.FilterScheduler diff --git a/cinder/tests/api/v1/test_limits.py b/cinder/tests/api/v1/test_limits.py index 711d57320..935a1c394 100644 --- a/cinder/tests/api/v1/test_limits.py +++ b/cinder/tests/api/v1/test_limits.py @@ -424,7 +424,7 @@ class LimiterTest(BaseLimitTestSuite): """test delay on 11th put request. the 11th PUT will result in a delay of 6.0 seconds until - the next request will be granced. + the next request will be granted. """ expected = [None] * 10 + [6.0] results = list(self._check(11, "PUT", "/anything")) @@ -435,7 +435,7 @@ class LimiterTest(BaseLimitTestSuite): """test delay of 8th post request. Ensure that the 8th POST will result in a delay of 6.0 seconds - until the next request will be granced. + until the next request will be granted. """ expected = [None] * 7 results = list(self._check(7, "POST", "/anything")) diff --git a/cinder/tests/db/test_qos_specs.py b/cinder/tests/db/test_qos_specs.py index a6357a4b5..02304bb2a 100644 --- a/cinder/tests/db/test_qos_specs.py +++ b/cinder/tests/db/test_qos_specs.py @@ -14,7 +14,7 @@ # License for the specific language governing permissions and limitations # under the License. -"""Tests for qaulity_of_service_specs table.""" +"""Tests for quality_of_service_specs table.""" import time diff --git a/cinder/tests/image/test_glance.py b/cinder/tests/image/test_glance.py index b252ac987..e5f9ec138 100644 --- a/cinder/tests/image/test_glance.py +++ b/cinder/tests/image/test_glance.py @@ -79,7 +79,7 @@ class TestGlanceImageService(test.TestCase): At a high level, the translations involved are: 1. Glance -> ImageService - This is needed so we can support - multple ImageServices (Glance, Local, etc) + multiple ImageServices (Glance, Local, etc) 2. ImageService -> API - This is needed so we can support multple APIs (OpenStack, EC2) diff --git a/cinder/tests/test_pure.py b/cinder/tests/test_pure.py index d56bc4329..bcf3af7ba 100644 --- a/cinder/tests/test_pure.py +++ b/cinder/tests/test_pure.py @@ -114,7 +114,7 @@ class PureISCSIDriverTestCase(test.TestCase): self.driver.do_setup, None) def assert_error_propagates(self, mocks, func, *args, **kwargs): - """Assert that errors from mocks propogate to func. + """Assert that errors from mocks propagate to func. Fail if exceptions raised by mocks are not seen when calling func(*args, **kwargs). Ensure that we are really seeing exceptions @@ -345,7 +345,7 @@ class FlashArrayBaseTestCase(test.TestCase): self.array = array def assert_error_propagates(self, mocks, func, *args, **kwargs): - """Assert that errors from mocks propogate to func. + """Assert that errors from mocks propagate to func. Fail if exceptions raised by mocks are not seen when calling func(*args, **kwargs). Ensure that we are really seeing exceptions diff --git a/cinder/volume/driver.py b/cinder/volume/driver.py index 60892239b..14415be32 100644 --- a/cinder/volume/driver.py +++ b/cinder/volume/driver.py @@ -175,7 +175,7 @@ class VolumeDriver(object): data path related implementation should be a *member object* that we call a connector. The point here is that for example don't allow the LVM driver to implement iSCSI methods, instead - call whatever connector it has configued via conf file + call whatever connector it has configured via conf file (iSCSI{LIO, TGT, IET}, FC, etc). In the base class and for example the LVM driver we do this via a has-a diff --git a/cinder/volume/drivers/emc/emc_cli_fc.py b/cinder/volume/drivers/emc/emc_cli_fc.py index e4ccff550..d4c66f407 100644 --- a/cinder/volume/drivers/emc/emc_cli_fc.py +++ b/cinder/volume/drivers/emc/emc_cli_fc.py @@ -123,7 +123,7 @@ class EMCCLIFCDriver(driver.FibreChannelDriver): The target_wwn can be a single entry or a list of wwns that correspond to the list of remote wwn(s) that will export the volume. The initiator_target_map is a map that represents the remote wwn(s) - and a list of wwns which are visiable to the remote wwn(s). + and a list of wwns which are visible to the remote wwn(s). Example return values: { diff --git a/cinder/volume/drivers/emc/emc_vmax_common.py b/cinder/volume/drivers/emc/emc_vmax_common.py index 20a0f6ba4..238029f85 100644 --- a/cinder/volume/drivers/emc/emc_vmax_common.py +++ b/cinder/volume/drivers/emc/emc_vmax_common.py @@ -1525,7 +1525,7 @@ class EMCVMAXCommon(object): self.conn = self._get_ecom_connection() def _initial_setup(self, volume): - """Necessary setup to accummulate the relevant information. + """Necessary setup to accumulate the relevant information. The volume object has a host in which we can parse the config group name. The config group name is the key to our EMC @@ -1744,7 +1744,7 @@ class EMCVMAXCommon(object): composite volume :param conn: the connection information to the ecom server - :param storageConfigService: thestorage config service instance name + :param storageConfigService: the storage config service instance name :param compositeVolumeInstanceName: the composite volume instance name :param additionalSize: the size you want to increase the volume by :returns: volume instance modifiedCompositeVolumeInstance diff --git a/cinder/volume/drivers/emc/emc_vmax_fast.py b/cinder/volume/drivers/emc/emc_vmax_fast.py index 9e3cbc555..9a2312cf9 100644 --- a/cinder/volume/drivers/emc/emc_vmax_fast.py +++ b/cinder/volume/drivers/emc/emc_vmax_fast.py @@ -674,7 +674,7 @@ class EMCVMAXFast(object): def get_capacities_associated_to_policy(self, conn, arrayName, policyName): """Gets the total and un-used capacities for all pools in a policy. - Given the name of the policy, get the total capcity and un-used + Given the name of the policy, get the total capacity and un-used capacity in GB of all the storage pools associated with the policy. :param policyName: the name of policy rule, a string value diff --git a/cinder/volume/drivers/emc/emc_vmax_masking.py b/cinder/volume/drivers/emc/emc_vmax_masking.py index de7965855..793794201 100644 --- a/cinder/volume/drivers/emc/emc_vmax_masking.py +++ b/cinder/volume/drivers/emc/emc_vmax_masking.py @@ -539,7 +539,7 @@ class EMCVMAXMasking(object): return foundHardwardIDsInstanceNames def _get_initiator_group_from_job(self, conn, job): - """After creating an new intiator group find it and return it + """After creating an new initiator group find it and return it :param conn: the connection to the ecom server :param job: the create initiator group job @@ -562,7 +562,7 @@ class EMCVMAXMasking(object): def _create_masking_view( self, conn, configService, maskingViewName, deviceMaskingGroup, targetMaskingGroup, initiatorMaskingGroup): - """After creating an new intiator group find it and return it. + """After creating an new initiator group find it and return it. :param conn: the connection to the ecom server :param configService: the create initiator group job @@ -872,7 +872,7 @@ class EMCVMAXMasking(object): def _get_initiator_group_from_masking_view( self, conn, maskingViewName, storageSystemName): - """Given the masking view name get the inititator group from it. + """Given the masking view name get the initiator group from it. :param conn: connection the the ecom server :param maskingViewName: the name of the masking view diff --git a/cinder/volume/drivers/emc/emc_vnx_cli.py b/cinder/volume/drivers/emc/emc_vnx_cli.py index 218d1ca40..903d2161a 100644 --- a/cinder/volume/drivers/emc/emc_vnx_cli.py +++ b/cinder/volume/drivers/emc/emc_vnx_cli.py @@ -1610,7 +1610,7 @@ class EMCVnxCliBase(object): def _is_valid_for_storage_assisted_migration( self, volume, host, new_type=None): - """Check the src and dest volume to decide the mogration type.""" + """Check the src and dest volume to decide the migration type.""" false_ret = (False, None) if 'location_info' not in host['capabilities']: diff --git a/cinder/volume/drivers/hds/iscsi.py b/cinder/volume/drivers/hds/iscsi.py index f4350a56d..11da3541c 100644 --- a/cinder/volume/drivers/hds/iscsi.py +++ b/cinder/volume/drivers/hds/iscsi.py @@ -413,7 +413,7 @@ class HDSISCSIDriver(driver.ISCSIDriver): def remove_export(self, context, volume): """Disconnect a volume from an attached instance. :param context: context - :param volume: dictionary volume referencej + :param volume: dictionary volume reference """ provider = volume['provider_location'] diff --git a/cinder/volume/drivers/san/hp/hp_msa_common.py b/cinder/volume/drivers/san/hp/hp_msa_common.py index b10739bc1..dd8489b36 100644 --- a/cinder/volume/drivers/san/hp/hp_msa_common.py +++ b/cinder/volume/drivers/san/hp/hp_msa_common.py @@ -158,7 +158,7 @@ class HPMSACommon(object): raise exception.HPMSANotEnoughSpace(vdisk=self.vdisk) def _assert_source_detached(self, volume): - """The MSA requires a volume to be dettached to clone it. + """The MSA requires a volume to be detached to clone it. Make sure that the volume is not in use when trying to copy it. """ diff --git a/cinder/volume/drivers/solidfire.py b/cinder/volume/drivers/solidfire.py index 15b2fd1f8..20cb5fd38 100644 --- a/cinder/volume/drivers/solidfire.py +++ b/cinder/volume/drivers/solidfire.py @@ -610,7 +610,7 @@ class SolidFireDriver(SanISCSIDriver): Note that for SolidFire Clusters currently there is no snapshot implementation. Due to the way SF does cloning there's no performance hit or extra space used. The only thing that's lacking from this is - the abilit to restore snaps. + the ability to restore snaps. After GA a true snapshot implementation will be available with restore at which time we'll rework this appropriately. diff --git a/cinder/volume/drivers/zfssa/restclient.py b/cinder/volume/drivers/zfssa/restclient.py index 1e4122fab..4f98c22b5 100644 --- a/cinder/volume/drivers/zfssa/restclient.py +++ b/cinder/volume/drivers/zfssa/restclient.py @@ -242,7 +242,7 @@ class RestClientURL(object): def request(self, path, request, body=None, **kwargs): """Make an HTTP request and return the results - :param path: Path used with the initiazed URL to make a request + :param path: Path used with the initialized URL to make a request :param request: HTTP request type (GET, POST, PUT, DELETE) :param body: HTTP body of request :key accept: Set HTTP 'Accept' header with this value -- 2.45.2