Normalize more help strings

Change-Id: I2b21bc904e35c1cc50da369d148e607fe3e8cf90

Author: Dean Troyer

openstackclient/compute/v2/console.py

@@ -26,7 +26,7 @@
 
 
 class ShowConsoleLog(command.Command):
-    """Show console-log command"""
+    """Show server's console output"""
 
     log = logging.getLogger(__name__ + '.ShowConsoleLog')
 
@@ -35,7 +35,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'server',
             metavar='<server>',
-            help='Name or ID of server to display console log',
+            help='Server (name or ID)',
         )
         parser.add_argument(
             '--lines',
@@ -67,7 +67,7 @@ def take_action(self, parsed_args):
 
 
 class ShowConsoleURL(show.ShowOne):
-    """Show console-url command"""
+    """Show server's remote console URL"""
 
     log = logging.getLogger(__name__ + '.ShowConsoleURL')
 
@@ -76,7 +76,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'server',
             metavar='<server>',
-            help='Name or ID of server to display console log',
+            help='Server (name or ID)',
         )
         type_group = parser.add_mutually_exclusive_group()
         type_group.add_argument(

openstackclient/compute/v2/flavor.py

@@ -26,7 +26,7 @@
 
 
 class CreateFlavor(show.ShowOne):
-    """Create flavor command"""
+    """Create new flavor"""
 
     log = logging.getLogger(__name__ + ".CreateFlavor")
 
@@ -35,7 +35,8 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "name",
             metavar="<name>",
-            help="Name of the new flavor")
+            help="New flavor name",
+        )
         parser.add_argument(
             "--id",
             metavar="<id>",
@@ -84,12 +85,14 @@ def get_parser(self, prog_name):
             dest="public",
             action="store_true",
             default=True,
-            help="Flavor is accessible to the public (default)")
+            help="Flavor is accessible to other projects (default)",
+        )
         public_group.add_argument(
             "--private",
             dest="public",
             action="store_false",
-            help="Flavor is inaccessible to the public")
+            help="Flavor is inaccessible to other projects",
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -115,7 +118,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteFlavor(command.Command):
-    """Delete flavor command"""
+    """Delete a flavor"""
 
     log = logging.getLogger(__name__ + ".DeleteFlavor")
 
@@ -124,7 +127,8 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "flavor",
             metavar="<flavor>",
-            help="Name or ID of flavor to delete")
+            help="Flavor to delete (name or ID)",
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -137,7 +141,7 @@ def take_action(self, parsed_args):
 
 
 class ListFlavor(lister.Lister):
-    """List flavor command"""
+    """List flavors"""
 
     log = logging.getLogger(__name__ + ".ListFlavor")
 
@@ -164,7 +168,7 @@ def take_action(self, parsed_args):
 
 
 class ShowFlavor(show.ShowOne):
-    """Show flavor command"""
+    """Show flavor details"""
 
     log = logging.getLogger(__name__ + ".ShowFlavor")
 
@@ -173,7 +177,8 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "flavor",
             metavar="<flavor>",
-            help="Name or ID of flavor to display")
+            help="Flavor to display (name or ID)",
+        )
         return parser
 
     def take_action(self, parsed_args):

openstackclient/compute/v2/floatingip.py

@@ -26,7 +26,7 @@
 
 
 class AddFloatingIP(command.Command):
-    """Add floating-ip command"""
+    """Add floating-ip to server"""
 
     log = logging.getLogger(__name__ + ".AddFloatingIP")
 
@@ -40,7 +40,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "server",
             metavar="<server>",
-            help="Name of the server to receive the IP address",
+            help="Server to receive the IP address (name or ID)",
         )
         return parser
 
@@ -56,7 +56,7 @@ def take_action(self, parsed_args):
 
 
 class CreateFloatingIP(show.ShowOne):
-    """Create floating-ip command"""
+    """Create new floating-ip"""
 
     log = logging.getLogger(__name__ + '.CreateFloatingIP')
 
@@ -80,7 +80,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteFloatingIP(command.Command):
-    """Delete floating-ip command"""
+    """Delete a floating-ip"""
 
     log = logging.getLogger(__name__ + '.DeleteFloatingIP')
 
@@ -107,7 +107,7 @@ def take_action(self, parsed_args):
 
 
 class ListFloatingIP(lister.Lister):
-    """List floating-ip command"""
+    """List floating-ips"""
 
     log = logging.getLogger(__name__ + '.ListFloatingIP')
 
@@ -127,7 +127,7 @@ def take_action(self, parsed_args):
 
 
 class RemoveFloatingIP(command.Command):
-    """Remove floating-ip command"""
+    """Remove floating-ip from server"""
 
     log = logging.getLogger(__name__ + ".RemoveFloatingIP")
 
@@ -141,7 +141,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "server",
             metavar="<server>",
-            help="Name of the server to remove the IP address from",
+            help="Server to remove the IP address from (name or ID)",
         )
         return parser
 

openstackclient/compute/v2/floatingippool.py

@@ -23,7 +23,7 @@
 
 
 class ListFloatingIPPool(lister.Lister):
-    """List floating-ip-pool command"""
+    """List floating-ip-pools"""
 
     log = logging.getLogger(__name__ + '.ListFloatingIPPool')
 

openstackclient/compute/v2/hypervisor.py

@@ -25,17 +25,17 @@
 
 
 class ListHypervisor(lister.Lister):
-    """List hypervisor command"""
+    """List hypervisors"""
 
     log = logging.getLogger(__name__ + ".ListHypervisor")
 
     def get_parser(self, prog_name):
         parser = super(ListHypervisor, self).get_parser(prog_name)
         parser.add_argument(
             "--matching",
-            metavar="<hostname>",
-            help="List hypervisors with hostnames matching the given"
-                 " substring")
+            metavar="<hostname-str>",
+            help="Filter hypervisors using <hostname-str> substring",
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -58,7 +58,7 @@ def take_action(self, parsed_args):
 
 
 class ShowHypervisor(show.ShowOne):
-    """Show hypervisor command"""
+    """Show hypervisor details"""
 
     log = logging.getLogger(__name__ + ".ShowHypervisor")
 

openstackclient/compute/v2/keypair.py

@@ -29,7 +29,7 @@
 
 
 class CreateKeypair(show.ShowOne):
-    """Create keypair command"""
+    """Create new keypair"""
 
     log = logging.getLogger(__name__ + '.CreateKeypair')
 
@@ -79,7 +79,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteKeypair(command.Command):
-    """Delete keypair command"""
+    """Delete a keypair"""
 
     log = logging.getLogger(__name__ + '.DeleteKeypair')
 
@@ -100,7 +100,7 @@ def take_action(self, parsed_args):
 
 
 class ListKeypair(lister.Lister):
-    """List keypair command"""
+    """List keypairs"""
 
     log = logging.getLogger(__name__ + ".ListKeypair")
 
@@ -120,7 +120,7 @@ def take_action(self, parsed_args):
 
 
 class ShowKeypair(show.ShowOne):
-    """Show keypair command"""
+    """Show keypair details"""
 
     log = logging.getLogger(__name__ + '.ShowKeypair')
 

openstackclient/identity/v2_0/token.py

@@ -41,7 +41,7 @@ def take_action(self, parsed_args):
 
 
 class RevokeToken(command.Command):
-    """Revoke token command"""
+    """Revoke existing token"""
 
     log = logging.getLogger(__name__ + '.RevokeToken')
 

openstackclient/identity/v3/identity_provider.py

@@ -25,15 +25,15 @@
 
 
 class CreateIdentityProvider(show.ShowOne):
-    """Create identity_provider command"""
+    """Create new identity provider"""
 
     log = logging.getLogger(__name__ + '.CreateIdentityProvider')
 
     def get_parser(self, prog_name):
         parser = super(CreateIdentityProvider, self).get_parser(prog_name)
         parser.add_argument(
             'identity_provider_id',
-            metavar='<identity_provider_id>',
+            metavar='<identity-provider-id>',
             help='New identity provider ID (must be unique)'
         )
         parser.add_argument(
@@ -71,16 +71,16 @@ def take_action(self, parsed_args):
 
 
 class DeleteIdentityProvider(command.Command):
-    """Delete identity provider"""
+    """Delete an identity provider"""
 
     log = logging.getLogger(__name__ + '.DeleteIdentityProvider')
 
     def get_parser(self, prog_name):
         parser = super(DeleteIdentityProvider, self).get_parser(prog_name)
         parser.add_argument(
             'identity_provider',
-            metavar='<identity_provider>',
-            help='ID of the identity provider to be deleted',
+            metavar='<identity-provider-id>',
+            help='Identity provider ID to delete',
         )
         return parser
 
@@ -109,16 +109,16 @@ def take_action(self, parsed_args):
 
 
 class SetIdentityProvider(command.Command):
-    """Set identity provider"""
+    """Set identity provider properties"""
 
     log = logging.getLogger(__name__ + '.SetIdentityProvider')
 
     def get_parser(self, prog_name):
         parser = super(SetIdentityProvider, self).get_parser(prog_name)
         parser.add_argument(
             'identity_provider',
-            metavar='<identity_provider>',
-            help='ID of the identity provider to be changed',
+            metavar='<identity-provider-id>',
+            help='Identity provider ID to change',
         )
 
         enable_identity_provider = parser.add_mutually_exclusive_group()
@@ -155,16 +155,16 @@ def take_action(self, parsed_args):
 
 
 class ShowIdentityProvider(show.ShowOne):
-    """Show identity provider"""
+    """Show identity provider details"""
 
     log = logging.getLogger(__name__ + '.ShowIdentityProvider')
 
     def get_parser(self, prog_name):
         parser = super(ShowIdentityProvider, self).get_parser(prog_name)
         parser.add_argument(
             'identity_provider',
-            metavar='<identity_provider>',
-            help='ID of the identity provider to be displayed',
+            metavar='<identity-provider-id>',
+            help='Identity provider ID to show',
         )
         return parser