Commit 0db8331f authored by Stavros Sachtouris's avatar Stavros Sachtouris
Browse files

Fix sphinx commend-related warnings


parent 083093cf
......@@ -273,7 +273,7 @@ class _optional_output_cmd(object):
with_output=FlagArgument('show response headers', ('--with-output')),
'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):
......@@ -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):
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(
......@@ -57,10 +57,10 @@ class CycladesClient(CycladesRestClient, Waiter):
describing files to be injected into virtual server upon creation
:param networks: (list of dicts) Networks to connect to, list this:
{"uuid": <network_uuid>},
{"uuid": <network_uuid>, "fixed_ip": address},
{"port": <port_id>}, ...]
"networks": [
{"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'
......@@ -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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment