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"'
- 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
updates: Mike Grozak
"""

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

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

@ -109,7 +109,10 @@ options:
required: false
default: 30
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
default: null
others:

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

Loading…
Cancel
Save