Fix sphinx commend-related warnings
authorStavros Sachtouris <saxtouri@admin.grnet.gr>
Fri, 13 Dec 2013 13:10:15 +0000 (15:10 +0200)
committerStavros Sachtouris <saxtouri@admin.grnet.gr>
Fri, 13 Dec 2013 13:10:15 +0000 (15:10 +0200)
kamaki/cli/commands/__init__.py
kamaki/cli/commands/astakos.py
kamaki/clients/cyclades/__init__.py
kamaki/clients/network/__init__.py

index 0c9b609..78c0b36 100644 (file)
@@ -273,7 +273,7 @@ class _optional_output_cmd(object):
         with_output=FlagArgument('show response headers', ('--with-output')),
         json_output=FlagArgument(
             'show headers in json (DEPRECATED from v0.12,'
-            ' please use --output-format=json instead)', ('-j', '--json'))
+            '  please use --output-format=json instead)', ('-j', '--json'))
     )
 
     def _optional_output(self, r):
index 938b262..1d5136e 100644 (file)
@@ -596,13 +596,11 @@ _project_specs = """{
     "end_date": date,
     "join_policy": "auto" | "moderated" | "closed",  # default: "moderated"
     "leave_policy": "auto" | "moderated" | "closed", # default: "auto"
-    "resources": {
-        "cyclades.vm": {
-            "project_capacity": int or null,
-            "member_capacity": int
-            }
-        }
-    }
+    "resources": {"cyclades.vm": {
+    "project_capacity": int or null,
+    "member_capacity": int
+    }}}
+
 """
 
 
@@ -653,10 +651,10 @@ class project_info(_init_synnefo_astakosclient, _optional_json):
 @command(project_commands)
 class project_create(_init_synnefo_astakosclient, _optional_json):
     """Apply for a new project (enter data though standard input or file path)
+
     Project details must be provided as a json-formated dict from the
     standard input, or through a file
     """
-
     __doc__ += _project_specs
 
     arguments = dict(
index 512b066..2279e7a 100644 (file)
@@ -58,9 +58,9 @@ class CycladesClient(CycladesRestClient, Waiter):
 
         :param networks: (list of dicts) Networks to connect to, list this:
             "networks": [
-                {"uuid": <network_uuid>},
-                {"uuid": <network_uuid>, "fixed_ip": address},
-                {"port": <port_id>}, ...]
+            {"uuid": <network_uuid>},
+            {"uuid": <network_uuid>, "fixed_ip": address},
+            {"port": <port_id>}, ...]
             ATTENTION: Empty list is different to None. None means ' do not
             mention it', empty list means 'automatically get an ip'
 
index 98f7730..d80affe 100644 (file)
@@ -52,13 +52,14 @@ class NetworkClient(NetworkRestClient, Waiter):
 
     def create_networks(self, networks):
         """Atomic operation for batch network creation (all or nothing)
+
         :param networks: (list) [
             {name: ..(str).., admin_state_up: ..(bool).., shared: ..(bool)..},
             {name: ..(str).., admin_state_up: ..(bool).., shared: ..(bool)..}]
             name is mandatory, the rest is optional
             e.g., create_networks([
-                {name: 'net1', admin_state_up: True},
-                {name: 'net2'}])
+            {name: 'net1', admin_state_up: True},
+            {name: 'net2'}])
         :returns: (list of dicts) created networks details
         :raises ValueError: if networks is misformated
         :raises ClientError: if the request failed or didn't return 201
@@ -144,6 +145,7 @@ class NetworkClient(NetworkRestClient, Waiter):
 
     def create_subnets(self, subnets):
         """Atomic operation for batch subnet creation (all or nothing)
+
         :param subnets: (list of dicts) {key: ...} with all parameters in the
             method create_subnet, where method mandatory / optional paramteres
             respond to mandatory / optional paramters in subnets items
@@ -255,6 +257,7 @@ class NetworkClient(NetworkRestClient, Waiter):
 
     def create_ports(self, ports):
         """Atomic operation for batch port creation (all or nothing)
+
         :param ports: (list of dicts) {key: ...} with all parameters in the
             method create_port, where method mandatory / optional paramteres
             respond to mandatory / optional paramters in ports items