openstack/python-designateclient
Code Issues Proposed changes

Add period in help message

Browse Source 
Command help message uses help and CLI-Reference generation.
  and in convention, help message stops with period ".".

Change-Id: Ia42df8e65aa8ab44f15e28ee0e1753dc17086a48
This commit is contained in:
Atsushi SAKAI
2015-09-24 08:56:07 +09:00
parent b97ae05612
commit 46349932d6
4 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
designateclient/cli/domains.py
View File

@@ -37,7 +37,7 @@ class GetDomainCommand(base.GetCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(GetDomainCommand, self).get_parser(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 return parser
@@ -52,10 +52,10 @@ class CreateDomainCommand(base.CreateCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(CreateDomainCommand, self).get_parser(prog_name) parser = super(CreateDomainCommand, self).get_parser(prog_name)
parser.add_argument('--name', help="Domain name", required=True) parser.add_argument('--name', help="Domain name.", required=True)
parser.add_argument('--email', help="Domain email", 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('--ttl', type=int, help="Time to live (seconds).")
parser.add_argument('--description', help="Description") parser.add_argument('--description', help="Description.")
return parser return parser
@@ -80,12 +80,12 @@ class UpdateDomainCommand(base.UpdateCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(UpdateDomainCommand, self).get_parser(prog_name) parser = super(UpdateDomainCommand, self).get_parser(prog_name)
parser.add_argument('id', help="Domain ID or name") parser.add_argument('id', help="Domain ID or name.")
parser.add_argument('--name', help="Domain name") parser.add_argument('--name', help="Domain name.")
parser.add_argument('--email', help="Domain email") parser.add_argument('--email', help="Domain email.")
parser.add_argument('--ttl', type=int, help="Time to live (seconds)") parser.add_argument('--ttl', type=int, help="Time to live (seconds).")
description_group = parser.add_mutually_exclusive_group() description_group = parser.add_mutually_exclusive_group()
description_group.add_argument('--description', help="Description") description_group.add_argument('--description', help="Description.")
description_group.add_argument('--no-description', action='store_true') description_group.add_argument('--no-description', action='store_true')
return parser return parser
@@ -118,7 +118,7 @@ class DeleteDomainCommand(base.DeleteCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(DeleteDomainCommand, self).get_parser(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 return parser
@@ -135,7 +135,7 @@ class ListDomainServersCommand(base.ListCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ListDomainServersCommand, self).get_parser(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 return parser

12
designateclient/cli/quotas.py
View File

@@ -42,16 +42,16 @@ class UpdateQuotaCommand(base.UpdateCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(UpdateQuotaCommand, self).get_parser(prog_name) parser = super(UpdateQuotaCommand, self).get_parser(prog_name)
parser.add_argument('tenant_id', help="Tenant ID") 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', parser.add_argument('--domain-recordsets',
help="Allowed domain records", help="Allowed domain records.",
type=int) type=int)
parser.add_argument('--recordset-records', parser.add_argument('--recordset-records',
help="Allowed recordset records", help="Allowed recordset records.",
type=int) type=int)
parser.add_argument('--domain-records', parser.add_argument('--domain-records',
help="Allowed domain records", help="Allowed domain records.",
type=int) type=int)
return parser return parser
@@ -72,7 +72,7 @@ class ResetQuotaCommand(base.DeleteCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ResetQuotaCommand, self).get_parser(prog_name) parser = super(ResetQuotaCommand, self).get_parser(prog_name)
parser.add_argument('tenant_id', help="Tenant ID") parser.add_argument('tenant_id', help="Tenant ID.")
return parser return parser

40
designateclient/cli/records.py
View File

@@ -30,7 +30,7 @@ class ListRecordsCommand(base.ListCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ListRecordsCommand, self).get_parser(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 return parser
@@ -46,8 +46,8 @@ class GetRecordCommand(base.GetCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(GetRecordCommand, self).get_parser(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") parser.add_argument('id', help="Record ID.")
return parser return parser
@@ -63,14 +63,14 @@ class CreateRecordCommand(base.CreateCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(CreateRecordCommand, self).get_parser(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( parser.add_argument(
'--name', help="Record (relative|absolute) name", required=True) '--name', help="Record (relative|absolute) name.", required=True)
parser.add_argument('--type', help="Record type", required=True) parser.add_argument('--type', help="Record type.", required=True)
parser.add_argument('--data', help="Record data", required=True) parser.add_argument('--data', help="Record data.", required=True)
parser.add_argument('--ttl', type=int, help="Record TTL") 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") parser.add_argument('--description', help="Description.")
return parser return parser
@@ -115,24 +115,24 @@ class UpdateRecordCommand(base.UpdateCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(UpdateRecordCommand, self).get_parser(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('id', help="Record ID.")
parser.add_argument('--name', help="Record name") parser.add_argument('--name', help="Record name.")
parser.add_argument('--type', help="Record type") parser.add_argument('--type', help="Record type.")
parser.add_argument('--data', help="Record data") parser.add_argument('--data', help="Record data.")
description_group = parser.add_mutually_exclusive_group() description_group = parser.add_mutually_exclusive_group()
description_group.add_argument('--description', help="Description") description_group.add_argument('--description', help="Description.")
description_group.add_argument('--no-description', action='store_true') description_group.add_argument('--no-description', action='store_true')
ttl_group = parser.add_mutually_exclusive_group() ttl_group = parser.add_mutually_exclusive_group()
ttl_group.add_argument('--ttl', type=int, 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') ttl_group.add_argument('--no-ttl', action='store_true')
priotity_group = parser.add_mutually_exclusive_group() priotity_group = parser.add_mutually_exclusive_group()
priotity_group.add_argument('--priority', type=int, priotity_group.add_argument('--priority', type=int,
help="Record priority") help="Record priority.")
priotity_group.add_argument('--no-priority', action='store_true') priotity_group.add_argument('--no-priority', action='store_true')
return parser return parser
@@ -176,8 +176,8 @@ class DeleteRecordCommand(base.DeleteCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(DeleteRecordCommand, self).get_parser(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") parser.add_argument('id', help="Record ID.")
return parser return parser

10
designateclient/cli/servers.py
View File

@@ -37,7 +37,7 @@ class GetServerCommand(base.GetCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(GetServerCommand, self).get_parser(prog_name) parser = super(GetServerCommand, self).get_parser(prog_name)
parser.add_argument('id', help="Server ID") parser.add_argument('id', help="Server ID.")
return parser return parser
@@ -51,7 +51,7 @@ class CreateServerCommand(base.CreateCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(CreateServerCommand, self).get_parser(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 return parser
@@ -69,8 +69,8 @@ class UpdateServerCommand(base.UpdateCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(UpdateServerCommand, self).get_parser(prog_name) parser = super(UpdateServerCommand, self).get_parser(prog_name)
parser.add_argument('id', help="Server ID") parser.add_argument('id', help="Server ID.")
parser.add_argument('--name', help="Server name") parser.add_argument('--name', help="Server name.")
return parser return parser
@@ -90,7 +90,7 @@ class DeleteServerCommand(base.DeleteCommand):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(DeleteServerCommand, self).get_parser(prog_name) parser = super(DeleteServerCommand, self).get_parser(prog_name)
parser.add_argument('id', help="Server ID") parser.add_argument('id', help="Server ID.")
return parser return parser