Merge "Fix the description of functions"

zunclient/osc/v1/containers.py

@@ -352,7 +352,7 @@ class UnpauseContainer(command.Command):
 
 
 class ExecContainer(command.Command):
-    """Execute specified container"""
+    """Execute command in a running container"""
     log = logging.getLogger(__name__ + ".ExecContainer")
 
     def get_parser(self, prog_name):
@@ -431,8 +431,7 @@ class LogsContainer(command.Command):
 
 
 class KillContainer(command.Command):
-    """Kill specified containers"""
+    """Kill one or more running container(s)"""
-
     log = logging.getLogger(__name__ + ".KillContainers")
 
     def get_parser(self, prog_name):
@@ -498,7 +497,7 @@ class StopContainer(command.Command):
 
 
 class RunContainer(command.ShowOne):
-    """Creates and run a new container"""
+    """Create and run a new container"""
 
     log = logging.getLogger(__name__ + ".RunContainer")
 
@@ -622,7 +621,7 @@ class RunContainer(command.ShowOne):
 
 
 class RenameContainer(command.Command):
-    """rename specified container"""
+    """Rename specified container"""
     log = logging.getLogger(__name__ + ".RenameContainer")
 
     def get_parser(self, prog_name):
@@ -651,7 +650,7 @@ class RenameContainer(command.Command):
 
 
 class TopContainer(command.Command):
-    """display the running processes inside the container"""
+    """Display the running processes inside the container"""
     log = logging.getLogger(__name__ + ".TopContainer")
 
     def get_parser(self, prog_name):
@@ -681,7 +680,7 @@ class TopContainer(command.Command):
 
 
 class UpdateContainer(command.Command):
-    """Updates one or more container attributes"""
+    """Update one or more attributes of the container"""
     log = logging.getLogger(__name__ + ".UpdateContainer")
 
     def get_parser(self, prog_name):
@@ -719,7 +718,7 @@ class UpdateContainer(command.Command):
 
 
 class AttachContainer(command.Command):
-    """Attach to a specified containers"""
+    """Attach to a running container"""
 
     log = logging.getLogger(__name__ + ".AttachContainer")
 

zunclient/v1/containers_shell.py

@@ -339,7 +339,7 @@ def do_logs(cs, args):
            nargs=argparse.REMAINDER,
            help='The command to execute in a container')
 def do_exec(cs, args):
-    """Execute command in a container."""
+    """Execute command in a running container."""
     response = cs.containers.execute(args.container, ' '.join(args.command))
     output = response['output']
     exit_code = response['exit_code']
@@ -356,7 +356,7 @@ def do_exec(cs, args):
            default=None,
            help='The signal to kill')
 def do_kill(cs, args):
-    """kill signal to containers."""
+    """Kill one or more running container(s)."""
     for container in args.containers:
         opts = {}
         opts['id'] = container
@@ -426,7 +426,7 @@ def do_kill(cs, args):
            nargs=argparse.REMAINDER,
            help='Send command to the container')
 def do_run(cs, args):
-    """Run a command in a new container"""
+    """Run a command in a new container."""
     opts = {}
     opts['name'] = args.name
     opts['image'] = args.image
@@ -487,7 +487,7 @@ def do_rename(cs, args):
            metavar='<memory>',
            help='The container memory size in MiB')
 def do_update(cs, args):
-    """Updates one or more container attributes"""
+    """Update one or more attributes of the container."""
     opts = {}
     opts['memory'] = args.memory
     opts['cpu'] = args.cpu
@@ -502,7 +502,7 @@ def do_update(cs, args):
            metavar='<container>',
            help='ID or name of the container to be attahed to.')
 def do_attach(cs, args):
-    """Attach to a container."""
+    """Attach to a running container."""
     response = cs.containers.attach(args.container)
     websocketclient.do_attach(response, args.container, "~", 0.5)
 
@@ -515,7 +515,7 @@ def do_attach(cs, args):
            nargs=argparse.REMAINDER,
            help='The args of the ps command.')
 def do_top(cs, args):
-    """Displays the running processes inside the container."""
+    """Display the running processes inside the container."""
     output = cs.containers.top(args.container, ' '.join(args.ps_args))
     for titles in output['Titles']:
         print("%-20s") % titles,