Improve help strings

Improve consistency of help strings - also with other python clients:
* Add missing "." to sentences in shell.py, like the majority already
  was.
* Use sentence capitalization for all help strings (compare with
  shell.py).

Change-Id: Idb3c5ba5167efc8947b4f2e89ba1b4e3d1863e5e

7 files changed, 38 insertions, 37 deletions

diff --git a/designateclient/cli/diagnostics.py b/designateclient/cli/diagnostics.py
index 502529e..e621616 100644
--- a/designateclient/cli/diagnostics.py
+++ b/designateclient/cli/diagnostics.py
@@ -27,7 +27,7 @@ class PingCommand(base.GetCommand):
     def get_parser(self, prog_name):
         parser = super(PingCommand, self).get_parser(prog_name)
 
-        parser.add_argument('--service', help="Service Name (e.g. central)",
+        parser.add_argument('--service', help="Service name (e.g. central)",
                             required=True)
         parser.add_argument('--host', help="Hostname", required=True)
 
diff --git a/designateclient/cli/domains.py b/designateclient/cli/domains.py
index f848e1e..3976233 100644
--- a/designateclient/cli/domains.py
+++ b/designateclient/cli/domains.py
@@ -37,7 +37,7 @@ class GetDomainCommand(base.GetCommand):
     def get_parser(self, prog_name):
         parser = super(GetDomainCommand, self).get_parser(prog_name)
 
-        parser.add_argument('id', help="Domain ID or Name")
+        parser.add_argument('id', help="Domain ID or name")
 
         return parser
 
@@ -52,9 +52,9 @@ class CreateDomainCommand(base.CreateCommand):
     def get_parser(self, prog_name):
         parser = super(CreateDomainCommand, self).get_parser(prog_name)
 
-        parser.add_argument('--name', help="Domain Name", required=True)
-        parser.add_argument('--email', help="Domain Email", required=True)
-        parser.add_argument('--ttl', type=int, help="Time To Live (Seconds)")
+        parser.add_argument('--name', help="Domain name", required=True)
+        parser.add_argument('--email', help="Domain email", required=True)
+        parser.add_argument('--ttl', type=int, help="Time to live (seconds)")
         parser.add_argument('--description', help="Description")
 
         return parser
@@ -80,10 +80,10 @@ class UpdateDomainCommand(base.UpdateCommand):
     def get_parser(self, prog_name):
         parser = super(UpdateDomainCommand, self).get_parser(prog_name)
 
-        parser.add_argument('id', help="Domain ID or Name")
-        parser.add_argument('--name', help="Domain Name")
-        parser.add_argument('--email', help="Domain Email")
-        parser.add_argument('--ttl', type=int, help="Time To Live (Seconds)")
+        parser.add_argument('id', help="Domain ID or name")
+        parser.add_argument('--name', help="Domain name")
+        parser.add_argument('--email', help="Domain email")
+        parser.add_argument('--ttl', type=int, help="Time to live (seconds)")
         description_group = parser.add_mutually_exclusive_group()
         description_group.add_argument('--description', help="Description")
         description_group.add_argument('--no-description', action='store_true')
@@ -118,7 +118,7 @@ class DeleteDomainCommand(base.DeleteCommand):
     def get_parser(self, prog_name):
         parser = super(DeleteDomainCommand, self).get_parser(prog_name)
 
-        parser.add_argument('id', help="Domain ID or Name")
+        parser.add_argument('id', help="Domain ID or name")
 
         return parser
 
@@ -135,7 +135,7 @@ class ListDomainServersCommand(base.ListCommand):
     def get_parser(self, prog_name):
         parser = super(ListDomainServersCommand, self).get_parser(prog_name)
 
-        parser.add_argument('id', help="Domain ID or Name")
+        parser.add_argument('id', help="Domain ID or name")
 
         return parser
 
diff --git a/designateclient/cli/quotas.py b/designateclient/cli/quotas.py
index da85528..722c83e 100644
--- a/designateclient/cli/quotas.py
+++ b/designateclient/cli/quotas.py
@@ -43,15 +43,15 @@ class UpdateQuotaCommand(base.UpdateCommand):
         parser = super(UpdateQuotaCommand, self).get_parser(prog_name)
 
         parser.add_argument('tenant_id', help="Tenant ID")
-        parser.add_argument('--domains', help="Allowed Domains", type=int)
+        parser.add_argument('--domains', help="Allowed domains", type=int)
         parser.add_argument('--domain-recordsets',
-                            help="Allowed Domain Records",
+                            help="Allowed domain records",
                             type=int)
         parser.add_argument('--recordset-records',
-                            help="Allowed Recordset Records",
+                            help="Allowed recordset records",
                             type=int)
         parser.add_argument('--domain-records',
-                            help="Allowed Domain Records",
+                            help="Allowed domain records",
                             type=int)
         return parser
 
diff --git a/designateclient/cli/records.py b/designateclient/cli/records.py
index e05103c..c904b76 100644
--- a/designateclient/cli/records.py
+++ b/designateclient/cli/records.py
@@ -30,7 +30,7 @@ class ListRecordsCommand(base.ListCommand):
     def get_parser(self, prog_name):
         parser = super(ListRecordsCommand, self).get_parser(prog_name)
 
-        parser.add_argument('domain_id', help="Domain ID or Name")
+        parser.add_argument('domain_id', help="Domain ID or name")
 
         return parser
 
@@ -46,7 +46,7 @@ class GetRecordCommand(base.GetCommand):
     def get_parser(self, prog_name):
         parser = super(GetRecordCommand, self).get_parser(prog_name)
 
-        parser.add_argument('domain_id', help="Domain ID or Name")
+        parser.add_argument('domain_id', help="Domain ID or name")
         parser.add_argument('id', help="Record ID")
 
         return parser
@@ -63,13 +63,13 @@ class CreateRecordCommand(base.CreateCommand):
     def get_parser(self, prog_name):
         parser = super(CreateRecordCommand, self).get_parser(prog_name)
 
-        parser.add_argument('domain_id', help="Domain ID or Name")
+        parser.add_argument('domain_id', help="Domain ID or name")
         parser.add_argument(
-            '--name', help="Record (relative|absolute) Name", required=True)
-        parser.add_argument('--type', help="Record Type", required=True)
-        parser.add_argument('--data', help="Record Data", required=True)
+            '--name', help="Record (relative|absolute) name", required=True)
+        parser.add_argument('--type', help="Record type", required=True)
+        parser.add_argument('--data', help="Record data", required=True)
         parser.add_argument('--ttl', type=int, help="Record TTL")
-        parser.add_argument('--priority', type=int, help="Record Priority")
+        parser.add_argument('--priority', type=int, help="Record priority")
         parser.add_argument('--description', help="Description")
 
         return parser
@@ -115,11 +115,11 @@ class UpdateRecordCommand(base.UpdateCommand):
     def get_parser(self, prog_name):
         parser = super(UpdateRecordCommand, self).get_parser(prog_name)
 
-        parser.add_argument('domain_id', help="Domain ID or Name")
+        parser.add_argument('domain_id', help="Domain ID or name")
         parser.add_argument('id', help="Record ID")
-        parser.add_argument('--name', help="Record Name")
-        parser.add_argument('--type', help="Record Type")
-        parser.add_argument('--data', help="Record Data")
+        parser.add_argument('--name', help="Record name")
+        parser.add_argument('--type', help="Record type")
+        parser.add_argument('--data', help="Record data")
 
         description_group = parser.add_mutually_exclusive_group()
         description_group.add_argument('--description', help="Description")
@@ -127,12 +127,12 @@ class UpdateRecordCommand(base.UpdateCommand):
 
         ttl_group = parser.add_mutually_exclusive_group()
         ttl_group.add_argument('--ttl', type=int,
-                               help="Record Time To Live (Seconds)")
+                               help="Record time to live (seconds)")
         ttl_group.add_argument('--no-ttl', action='store_true')
 
         priotity_group = parser.add_mutually_exclusive_group()
         priotity_group.add_argument('--priority', type=int,
-                                    help="Record Priority")
+                                    help="Record priority")
         priotity_group.add_argument('--no-priority', action='store_true')
 
         return parser
@@ -176,7 +176,7 @@ class DeleteRecordCommand(base.DeleteCommand):
     def get_parser(self, prog_name):
         parser = super(DeleteRecordCommand, self).get_parser(prog_name)
 
-        parser.add_argument('domain_id', help="Domain ID or Name")
+        parser.add_argument('domain_id', help="Domain ID or name")
         parser.add_argument('id', help="Record ID")
 
         return parser
diff --git a/designateclient/cli/reports.py b/designateclient/cli/reports.py
index fc17b9c..6ecfc2e 100644
--- a/designateclient/cli/reports.py
+++ b/designateclient/cli/reports.py
@@ -62,7 +62,7 @@ class TenantCommand(base.ListCommand):
         parser = super(TenantCommand, self).get_parser(prog_name)
 
         parser.add_argument('--report-tenant-id',
-                            help="tenant_id being reported on",
+                            help="The tenant_id being reported on.",
                             required=True)
 
         return parser
diff --git a/designateclient/cli/servers.py b/designateclient/cli/servers.py
index bbe3a2f..c31f5ac 100644
--- a/designateclient/cli/servers.py
+++ b/designateclient/cli/servers.py
@@ -51,7 +51,7 @@ class CreateServerCommand(base.CreateCommand):
     def get_parser(self, prog_name):
         parser = super(CreateServerCommand, self).get_parser(prog_name)
 
-        parser.add_argument('--name', help="Server Name", required=True)
+        parser.add_argument('--name', help="Server name", required=True)
 
         return parser
 
@@ -70,7 +70,7 @@ class UpdateServerCommand(base.UpdateCommand):
         parser = super(UpdateServerCommand, self).get_parser(prog_name)
 
         parser.add_argument('id', help="Server ID")
-        parser.add_argument('--name', help="Server Name")
+        parser.add_argument('--name', help="Server name")
 
         return parser
 
diff --git a/designateclient/shell.py b/designateclient/shell.py
index 4e2649c..f7c8be4 100644
--- a/designateclient/shell.py
+++ b/designateclient/shell.py
@@ -152,22 +152,23 @@ class DesignateShell(App):
         parser.add_argument('--os-service-type',
                             default=env('OS_DNS_SERVICE_TYPE', default='dns'),
                             help=("Defaults to env[OS_DNS_SERVICE_TYPE], or "
-                                  "'dns'"))
+                                  "'dns'."))
 
         parser.add_argument('--os-cacert',
                             default=env('OS_CACERT'),
                             help=('CA certificate bundle file. Defaults to '
-                                  'env[OS_CACERT]'))
+                                  'env[OS_CACERT].'))
 
         parser.add_argument('--insecure', action='store_true',
-                            help="Explicitly allow 'insecure' SSL requests")
+                            help="Explicitly allow 'insecure' SSL requests.")
 
         parser.add_argument('--all-tenants', action='store_true',
-                            help="Allows to list all domains from all tenants")
+                            help="Allows to list all domains from all "
+                            "tenants.")
 
         parser.add_argument('--edit-managed', action='store_true',
                             help='Allows to edit records that are marked as '
-                            'managed')
+                            'managed.')
 
         return parser