Module documentation should have options sorted

reviewable/pr18780/r1
Michael DeHaan 12 years ago
parent 61a4674413
commit 78669c57d5

@ -29,7 +29,7 @@ description:
(U(https://github.com/puppetlabs/facter)) on the remote system, returning (U(https://github.com/puppetlabs/facter)) on the remote system, returning
JSON data that can be useful for inventory purposes. JSON data that can be useful for inventory purposes.
version_added: "0.2" version_added: "0.2"
options: [] options: {}
examples: examples:
- code: ansible www.example.net -m facter - code: ansible www.example.net -m facter
description: "Example command-line invocation" description: "Example command-line invocation"

@ -29,7 +29,7 @@ description:
returns JSON inventory data. returns JSON inventory data.
I(Ohai) data is a bit more verbose and nested than I(facter). I(Ohai) data is a bit more verbose and nested than I(facter).
version_added: "0.6" version_added: "0.6"
options: [] options: {}
examples: examples:
- code: ansible webservers -m ohai --tree=/tmp/ohaidata - code: ansible webservers -m ohai --tree=/tmp/ohaidata
description: "Retrieve I(ohai) data from all Web servers and store in one-file per host" description: "Retrieve I(ohai) data from all Web servers and store in one-file per host"

@ -27,6 +27,7 @@ description:
- A trivial test module, this module always returns 'pong' on successful - A trivial test module, this module always returns 'pong' on successful
contact. It does not make sense in playbooks, but is useful from contact. It does not make sense in playbooks, but is useful from
C(/usr/bin/ansible) C(/usr/bin/ansible)
options: {}
examples: examples:
- code: ansible webservers -m ping - code: ansible webservers -m ping
description: Test 'webservers' status description: Test 'webservers' status

1
raw

@ -4,6 +4,7 @@ DOCUMENTATION = '''
--- ---
module: raw module: raw
short_description: Executes a low-down and dirty SSH command short_description: Executes a low-down and dirty SSH command
options: {}
description: description:
- Executes a low-down and dirty SSH command, not going through the module - Executes a low-down and dirty SSH command, not going through the module
subsystem. This is useful and should only be done in two cases. The subsystem. This is useful and should only be done in two cases. The

@ -30,6 +30,7 @@ DOCUMENTATION = '''
--- ---
module: setup module: setup
short_description: Gathers facts about remote hosts short_description: Gathers facts about remote hosts
options: {}
description: description:
- This module is automatically called by playbooks to gather useful - This module is automatically called by playbooks to gather useful
variables about remote hosts that can be used in playbooks. It can also be variables about remote hosts that can be used in playbooks. It can also be

Loading…
Cancel
Save