Merge pull request #2535 from mavimo/documentation-description-formatting

Chnge description as list inside string
pull/2534/merge
Michael DeHaan 12 years ago
commit fe34bebbbb

@ -124,7 +124,8 @@ examples:
description: 'Creates an entry like "@reboot /some/job.sh"' description: 'Creates an entry like "@reboot /some/job.sh"'
- code: 'cron: name="yum autoupdate" weekday="2" minute=0 hour=12 user="root" job="YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate" cron_file=ansible_yum-autoupdate' - code: 'cron: name="yum autoupdate" weekday="2" minute=0 hour=12 user="root" job="YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate" cron_file=ansible_yum-autoupdate'
requirements: cron requirements:
- cron
author: Dane Summers author: Dane Summers
updates: Mike Grozak updates: Mike Grozak
""" """

@ -28,7 +28,8 @@ description:
version_added: "1.1" version_added: "1.1"
options: options:
name: name:
description: The name of the gem to be managed. description:
- The name of the gem to be managed.
required: true required: true
state: state:
description: description:
@ -36,19 +37,23 @@ options:
required: true required: true
choices: [present, absent, latest] choices: [present, absent, latest]
gem_source: gem_source:
description: The path to a local gem used as installation source. description:
- The path to a local gem used as installation source.
required: false required: false
include_dependencies: include_dependencies:
description: Wheter to include dependencies or not. description:
- Wheter to include dependencies or not.
required: false required: false
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
default: "yes" default: "yes"
repository: repository:
description: The repository from which the gem will be installed description:
- The repository from which the gem will be installed
required: false required: false
aliases: [source] aliases: [source]
version: version:
description: Version of the gem to be installed/removed. description:
- Version of the gem to be installed/removed.
required: false required: false
author: Johan Wiren author: Johan Wiren
''' '''

@ -36,7 +36,7 @@ options:
aliases: [vhost] aliases: [vhost]
tracing: tracing:
description: description:
Enable/disable tracing for a vhost - Enable/disable tracing for a vhost
default: "no" default: "no"
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
aliases: [trace] aliases: [trace]

@ -33,8 +33,8 @@ DOCUMENTATION = '''
module: uri module: uri
short_description: Interacts with webservices short_description: Interacts with webservices
description: description:
- Interacts with HTTP and HTTPS web services and supports Digest, Basic and WSSE - Interacts with HTTP and HTTPS web services and supports Digest, Basic and WSSE
HTTP authentication mechanisms. HTTP authentication mechanisms.
version_added: "1.1" version_added: "1.1"
options: options:
url: url:
@ -109,7 +109,10 @@ options:
required: false required: false
default: 30 default: 30
HEADER_: HEADER_:
description: Any parameter starting with "HEADER_" is a sent with your request as a header. For example, HEADER_Content-Type="application/json" would send the header "Content-Type" along with your request with a value of "application/json". description:
- Any parameter starting with "HEADER_" is a sent with your request as a header.
For example, HEADER_Content-Type="application/json" would send the header
"Content-Type" along with your request with a value of "application/json".
required: false required: false
default: null default: null
others: others:

@ -23,7 +23,8 @@ description:
version_added: "100.0" version_added: "100.0"
options: options:
state: state:
description: Should the VMs be "present" or "absent." description:
- Should the VMs be "present" or "absent."
cmd: cmd:
description: description:
- vagrant subcommand to execute. Can be "up," "status," "config," "ssh," "halt," "destroy" or "clear." - vagrant subcommand to execute. Can be "up," "status," "config," "ssh," "halt," "destroy" or "clear."

Loading…
Cancel
Save