From 265a51ab938aea6d86249331e9de2f1cafbd8a21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Andrei=20Minc=C4=83?= Date: Fri, 18 May 2018 18:46:49 +0300 Subject: [PATCH] format module values in gce_net module documentation (#40047) * format code in gce_net module The values passed to the module weren't being highlighted properly in the documentation page. As a result, use markup code format for the values provided in order to be spotted easily on the page. Signed-off-by: Daniel Andrei Minca * separate phrases Signed-off-by: Daniel Andrei Minca * apply review fix for module options According to http://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#formatting-functions Signed-off-by: Daniel Andrei Minca --- lib/ansible/modules/cloud/google/gce_net.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/lib/ansible/modules/cloud/google/gce_net.py b/lib/ansible/modules/cloud/google/gce_net.py index b47bd42e277..64a9721b9ef 100644 --- a/lib/ansible/modules/cloud/google/gce_net.py +++ b/lib/ansible/modules/cloud/google/gce_net.py @@ -28,12 +28,13 @@ description: options: allowed: description: - - the protocol:ports to allow ('tcp:80' or 'tcp:80,443' or 'tcp:80-800;udp:1-25') + - the protocol:ports to allow (I(tcp:80) or I(tcp:80,443) or I(tcp:80-800;udp:1-25)) this parameter is mandatory when creating or updating a firewall rule ipv4_range: description: - the IPv4 address range in CIDR notation for the network - this parameter is not mandatory when you specified existing network in name parameter, but when you create new network, this parameter is mandatory + this parameter is not mandatory when you specified existing network in name parameter, + but when you create new network, this parameter is mandatory aliases: ['cidr'] fwname: description: @@ -69,7 +70,7 @@ options: version_added: "1.6" description: - path to the pem file associated with the service account email - This option is deprecated. Use 'credentials_file'. + This option is deprecated. Use C(credentials_file). credentials_file: version_added: "2.1.0" description: @@ -82,9 +83,9 @@ options: version_added: "2.2" description: - network mode for Google Cloud - "legacy" indicates a network with an IP address range - "auto" automatically generates subnetworks in different regions - "custom" uses networks to group subnets of user specified IP address ranges + C(legacy) indicates a network with an IP address range; + C(auto) automatically generates subnetworks in different regions; + C(custom) uses networks to group subnets of user specified IP address ranges https://cloud.google.com/compute/docs/networking#network_types default: "legacy" choices: ["legacy", "auto", "custom"]