From ba8cc9493af822728790117bae95b84fef613eae Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Sat, 5 Sep 2015 08:55:34 -0700 Subject: [PATCH] correct documentation formatting --- .../modules/extras/cloud/amazon/s3_bucket.py | 2 +- .../modules/extras/cloud/amazon/s3_lifecycle.py | 14 +++++++------- .../cloud/vmware/vmware_target_canonical_facts.py | 4 ++-- lib/ansible/modules/extras/windows/win_package.py | 10 +++++----- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/lib/ansible/modules/extras/cloud/amazon/s3_bucket.py b/lib/ansible/modules/extras/cloud/amazon/s3_bucket.py index 8e660283472..cc0442eccc1 100644 --- a/lib/ansible/modules/extras/cloud/amazon/s3_bucket.py +++ b/lib/ansible/modules/extras/cloud/amazon/s3_bucket.py @@ -40,7 +40,7 @@ options: default: null region: description: - - AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard. + - "AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard." required: false default: null s3_url: diff --git a/lib/ansible/modules/extras/cloud/amazon/s3_lifecycle.py b/lib/ansible/modules/extras/cloud/amazon/s3_lifecycle.py index 3328a33f15f..7a54365c8bd 100644 --- a/lib/ansible/modules/extras/cloud/amazon/s3_lifecycle.py +++ b/lib/ansible/modules/extras/cloud/amazon/s3_lifecycle.py @@ -20,7 +20,7 @@ short_description: Manage s3 bucket lifecycle rules in AWS description: - Manage s3 bucket lifecycle rules in AWS version_added: "2.0" -author: Rob White (@wimnat) +author: "Rob White (@wimnat)" notes: - If specifying expiration time as days then transition time must also be specified in days - If specifying expiration time as a date then transition time must also be specified as a date @@ -35,7 +35,7 @@ options: description: - "Indicates the lifetime of the objects that are subject to the rule by the date they will expire. The value must be ISO-8601 format, the time must be midnight and a GMT timezone must be specified." required: false - default: null + default: null expiration_days: description: - "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." @@ -43,9 +43,9 @@ options: default: null prefix: description: - - "Prefix identifying one or more objects to which the rule applies. If no prefix is specified, the rule will apply to the whole bucket." - required: false - default: null + - "Prefix identifying one or more objects to which the rule applies. If no prefix is specified, the rule will apply to the whole bucket." + required: false + default: null region: description: - "AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard." @@ -54,8 +54,8 @@ options: rule_id: description: - "Unique identifier for the rule. The value cannot be longer than 255 characters. A unique value for the rule will be generated if no value is provided." - required: false - default: null + required: false + default: null state: description: - "Create or remove the lifecycle rule" diff --git a/lib/ansible/modules/extras/cloud/vmware/vmware_target_canonical_facts.py b/lib/ansible/modules/extras/cloud/vmware/vmware_target_canonical_facts.py index 987b4a98753..028fc8c83a2 100644 --- a/lib/ansible/modules/extras/cloud/vmware/vmware_target_canonical_facts.py +++ b/lib/ansible/modules/extras/cloud/vmware/vmware_target_canonical_facts.py @@ -24,14 +24,14 @@ module: vmware_target_canonical_facts short_description: Return canonical (NAA) from an ESXi host description: - Return canonical (NAA) from an ESXi host based on SCSI target ID -version_added: 2.0 +version_added: "2.0" author: Joseph Callen notes: requirements: - Tested on vSphere 5.5 - PyVmomi installed options: - hostname: + hostname: description: - The hostname or IP address of the vSphere vCenter required: True diff --git a/lib/ansible/modules/extras/windows/win_package.py b/lib/ansible/modules/extras/windows/win_package.py index 3072dbed3de..d20e5ee8816 100644 --- a/lib/ansible/modules/extras/windows/win_package.py +++ b/lib/ansible/modules/extras/windows/win_package.py @@ -44,7 +44,7 @@ options: product_id: description: - product id of the installed package (used for checking if already installed) - required: false + required: false default: null aliases: [] arguments: @@ -54,20 +54,20 @@ options: aliases: [] state: description: - - Install or Uninstall - choices: + - Install or Uninstall + choices: - present - absent default: present aliases: [ensure] user_name: description: - - Username of an account with access to the package if its located on a file share. Only needed if the winrm user doesn't have access to the package. Also specify user_password for this to function properly. + - Username of an account with access to the package if its located on a file share. Only needed if the winrm user doesn't have access to the package. Also specify user_password for this to function properly. default: null aliases: [] user_password: description: - - Password of an account with access to the package if its located on a file share. Only needed if the winrm user doesn't have access to the package. Also specify user_name for this to function properly. + - Password of an account with access to the package if its located on a file share. Only needed if the winrm user doesn't have access to the package. Also specify user_name for this to function properly. default: null aliases: [] author: Trond Hindenes