provided all the docstrings for commands

slapos/cli/bang.py

@@ -7,6 +7,9 @@ from slapos.bang import do_bang
 
 
 class BangCommand(ConfigCommand):
+    """
+    request update on all partitions
+    """
 
     log = logging.getLogger(__name__)
 

slapos/cli/cache.py

@@ -8,7 +8,7 @@ from slapos.cache import do_lookup
 
 class CacheLookupCommand(ConfigCommand):
     """
-    Perform a query to the networkcache.
+    perform a query to the networkcache
     You can provide either a complete URL to the software release,
     or a corresponding MD5 hash value.
 

slapos/cli/console.py

@@ -8,7 +8,7 @@ from slapos.client import init, do_console, ClientConfig
 
 class ConsoleCommand(ClientConfigCommand):
     """
-    Python prompt to interact with slap API.
+    python prompt to interact with slap API
 
     You can play with the global "slap" object and
     with the global "request" method.

slapos/cli/format.py

@@ -10,6 +10,9 @@ from slapos.format import do_format, FormatConfig, tracing_monkeypatch, UsageErr
 
 
 class FormatCommand(ConfigCommand):
+    """
+    create users, partitions and network configuration
+    """
 
     log = logging.getLogger('slapformat')
 

slapos/cli/register.py

@@ -8,6 +8,9 @@ from slapos.register.register import do_register, RegisterConfig
 
 
 class RegisterCommand(Command):
+    """
+    register a node in the SlapOS cloud
+    """
 
     log = logging.getLogger('Register')
 

slapos/cli/remove.py

@@ -7,6 +7,9 @@ from slapos.client import init, do_remove, ClientConfig
 
 
 class RemoveCommand(ClientConfigCommand):
+    """
+    remove a Software from a node
+    """
 
     log = logging.getLogger(__name__)
 

slapos/cli/request.py

@@ -21,6 +21,9 @@ def parse_option_dict(options):
 
 
 class RequestCommand(ClientConfigCommand):
+    """
+    request an Instance
+    """
 
     log = logging.getLogger(__name__)
 

slapos/cli/slapgrid.py

@@ -22,7 +22,7 @@ class SlapgridCommand(ConfigCommand):
     def get_parser(self, prog_name):
         ap = super(SlapgridCommand, self).get_parser(prog_name)
 
-        # XXX TODO separate parsers for instance, software and report?
+        # TODO move more options to the instance, software and report subclasses
 
         ap.add_argument('--instance-root',
                         help='The instance root directory location.')
@@ -86,7 +86,7 @@ class SlapgridCommand(ConfigCommand):
 
 
 class SoftwareCommand(SlapgridCommand):
-    """Hook for entry point to process Software Releases"""
+    """hook for entry point to process Software Releases"""
 
     method_name = 'processSoftwareReleaseList'
     default_pidfile = '/opt/slapos/slapgrid-sr.pid'
@@ -101,7 +101,7 @@ class SoftwareCommand(SlapgridCommand):
 
 
 class InstanceCommand(SlapgridCommand):
-    """Hook for entry point to process Computer Partitions"""
+    """hook for entry point to process Computer Partitions"""
 
     method_name = 'processComputerPartitionList'
     default_pidfile = '/opt/slapos/slapgrid-cp.pid'
@@ -116,7 +116,7 @@ class InstanceCommand(SlapgridCommand):
 
 
 class ReportCommand(SlapgridCommand):
-    """Hook for entry point to process Usage Reports"""
+    """hook for entry point to process Usage Reports"""
 
     method_name = 'agregateAndSendUsage'
     default_pidfile = '/opt/slapos/slapgrid-ur.pid'

slapos/cli/supervisorctl.py

@@ -11,6 +11,9 @@ import supervisor.supervisorctl
 
 
 class SupervisorctlCommand(ConfigCommand):
+    """
+    manage supervisor processes
+    """
 
     log = logging.getLogger(__name__)
 

slapos/cli/supervisord.py

@@ -8,6 +8,7 @@ from slapos.grid.svcbackend import launchSupervisord
 
 
 class SupervisordCommand(ConfigCommand):
+    """run the supervisor daemon"""
 
     log = logging.getLogger(__name__)
 

slapos/cli/supply.py

@@ -7,6 +7,9 @@ from slapos.client import init, do_supply, ClientConfig
 
 
 class SupplyCommand(ClientConfigCommand):
+    """
+    supply a Software to a node
+    """
 
     log = logging.getLogger(__name__)