From fbf14a42bfc3d4b905ccffc6890d0bb86acddb5d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 2 Sep 2014 19:47:39 +0200 Subject: [PATCH] Fix help strings For consistency, add "." at end of help strings, fix grammar and capitalization. Remove "(float)" from heartbeat since the description will include the type. Change-Id: I0d6f4203b2b6de1dc22a156aa67526a067e48cbb --- ceilometer/api/__init__.py | 4 ++-- ceilometer/collector.py | 2 +- ceilometer/compute/virt/vmware/inspector.py | 12 ++++++------ ceilometer/compute/virt/xenapi/inspector.py | 7 ++++--- ceilometer/coordination.py | 2 +- ceilometer/data_processing/notifications.py | 2 +- ceilometer/hardware/discovery.py | 4 ++-- ceilometer/profiler/notifications.py | 2 +- 8 files changed, 18 insertions(+), 17 deletions(-) diff --git a/ceilometer/api/__init__.py b/ceilometer/api/__init__.py index 87ef84c04..adc2d9ad1 100644 --- a/ceilometer/api/__init__.py +++ b/ceilometer/api/__init__.py @@ -32,8 +32,8 @@ API_SERVICE_OPTS = [ cfg.BoolOpt('enable_reverse_dns_lookup', default=False, help=('Set it to False if your environment does not need ' - 'or have dns server, otherwise it will delay the ' - 'response from api.') + 'or have a DNS server, otherwise it will delay the ' + 'response from the API.') ), ] diff --git a/ceilometer/collector.py b/ceilometer/collector.py index a4739c3d7..0d0fcdee8 100644 --- a/ceilometer/collector.py +++ b/ceilometer/collector.py @@ -41,7 +41,7 @@ OPTS = [ default=False, help='Requeue the sample on the collector sample queue ' 'when the collector fails to dispatch it. This is only valid ' - 'if the sample come from the notifier publisher'), + 'if the sample come from the notifier publisher.'), ] cfg.CONF.register_opts(OPTS, group="collector") diff --git a/ceilometer/compute/virt/vmware/inspector.py b/ceilometer/compute/virt/vmware/inspector.py index 22fab9a85..37189fe6c 100644 --- a/ceilometer/compute/virt/vmware/inspector.py +++ b/ceilometer/compute/virt/vmware/inspector.py @@ -30,26 +30,26 @@ opt_group = cfg.OptGroup(name='vmware', OPTS = [ cfg.StrOpt('host_ip', default='', - help='IP address of the VMware Vsphere host'), + help='IP address of the VMware Vsphere host.'), cfg.StrOpt('host_username', default='', - help='Username of VMware Vsphere'), + help='Username of VMware Vsphere.'), cfg.StrOpt('host_password', default='', - help='Password of VMware Vsphere', + help='Password of VMware Vsphere.', secret=True), cfg.IntOpt('api_retry_count', default=10, - help='Number of times a VMware Vsphere API must be retried'), + help='Number of times a VMware Vsphere API may be retried.'), cfg.FloatOpt('task_poll_interval', default=0.5, help='Sleep time in seconds for polling an ongoing async ' - 'task'), + 'task.'), cfg.StrOpt('wsdl_location', help='Optional vim service WSDL location ' 'e.g http:///vimService.wsdl. ' 'Optional over-ride to default location for bug ' - 'work-arounds'), + 'work-arounds.'), ] cfg.CONF.register_group(opt_group) diff --git a/ceilometer/compute/virt/xenapi/inspector.py b/ceilometer/compute/virt/xenapi/inspector.py index 829d2cac2..a38a06b8b 100644 --- a/ceilometer/compute/virt/xenapi/inspector.py +++ b/ceilometer/compute/virt/xenapi/inspector.py @@ -32,12 +32,13 @@ opt_group = cfg.OptGroup(name='xenapi', xenapi_opts = [ cfg.StrOpt('connection_url', - help='URL for connection to XenServer/Xen Cloud Platform'), + help='URL for connection to XenServer/Xen Cloud Platform.'), cfg.StrOpt('connection_username', default='root', - help='Username for connection to XenServer/Xen Cloud Platform'), + help='Username for connection to XenServer/Xen Cloud ' + 'Platform.'), cfg.StrOpt('connection_password', - help='Password for connection to XenServer/Xen Cloud Platform', + help='Password for connection to XenServer/Xen Cloud Platform.', secret=True), cfg.IntOpt('login_timeout', default=10, diff --git a/ceilometer/coordination.py b/ceilometer/coordination.py index 061b1293b..59365a9fa 100644 --- a/ceilometer/coordination.py +++ b/ceilometer/coordination.py @@ -37,7 +37,7 @@ OPTS = [ cfg.FloatOpt('heartbeat', default=1.0, help='Number of seconds between heartbeats for distributed ' - 'coordination (float)') + 'coordination.') ] cfg.CONF.register_opts(OPTS, group='coordination') diff --git a/ceilometer/data_processing/notifications.py b/ceilometer/data_processing/notifications.py index 06010700a..8a4aca269 100644 --- a/ceilometer/data_processing/notifications.py +++ b/ceilometer/data_processing/notifications.py @@ -24,7 +24,7 @@ from ceilometer import sample OPTS = [ cfg.StrOpt('sahara_control_exchange', default='sahara', - help="Exchange name for Data Processing notifications"), + help="Exchange name for Data Processing notifications."), ] cfg.CONF.register_opts(OPTS) diff --git a/ceilometer/hardware/discovery.py b/ceilometer/hardware/discovery.py index 643830879..b732e7c4f 100644 --- a/ceilometer/hardware/discovery.py +++ b/ceilometer/hardware/discovery.py @@ -25,13 +25,13 @@ LOG = log.getLogger(__name__) OPTS = [ cfg.StrOpt('url_scheme', default='snmp://', - help='URL scheme to use for hardware nodes'), + help='URL scheme to use for hardware nodes.'), cfg.StrOpt('readonly_user_name', default='ro_snmp_user', help='SNMPd user name of all nodes running in the cloud.'), cfg.StrOpt('readonly_user_password', default='password', - help='SNMPd password of all the nodes running in the cloud'), + help='SNMPd password of all the nodes running in the cloud.'), ] cfg.CONF.register_opts(OPTS, group='hardware') diff --git a/ceilometer/profiler/notifications.py b/ceilometer/profiler/notifications.py index f2bb02e5b..ee4363a1b 100644 --- a/ceilometer/profiler/notifications.py +++ b/ceilometer/profiler/notifications.py @@ -23,7 +23,7 @@ from ceilometer import sample OPTS = [ cfg.StrOpt('trove_control_exchange', default='trove', - help="Exchange name for DBaaS notifications"), + help="Exchange name for DBaaS notifications."), ] cfg.CONF.register_opts(OPTS)