1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Use module formatting (#33413)

This commit is contained in:
John R Barker 2017-12-07 14:26:52 +00:00 committed by GitHub
parent c2bef76c46
commit 4d67cdd1f7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 7 additions and 7 deletions

View file

@ -18,7 +18,7 @@ DOCUMENTATION = '''
- Ansible callback plugin for timing individual tasks and overall execution time. - Ansible callback plugin for timing individual tasks and overall execution time.
- "Mashup of 2 excellent original works: https://github.com/jlafon/ansible-profile, - "Mashup of 2 excellent original works: https://github.com/jlafon/ansible-profile,
https://github.com/junaid18183/ansible_home/blob/master/ansible_plugins/callback_plugins/timestamp.py.old" https://github.com/junaid18183/ansible_home/blob/master/ansible_plugins/callback_plugins/timestamp.py.old"
- "Format: ``<task start timestamp> (<length of previous task>) <current elapsed playbook execution time>``" - "Format: C(<task start timestamp> (<length of previous task>) <current elapsed playbook execution time>)"
- It also lists the top/bottom time consuming tasks in the summary (configurable) - It also lists the top/bottom time consuming tasks in the summary (configurable)
- Before 2.4 only the environment variables were available for configuration. - Before 2.4 only the environment variables were available for configuration.
requirements: requirements:

View file

@ -29,7 +29,7 @@ DOCUMENTATION = """
remote_user: remote_user:
description: description:
- User to login/authenticate as - User to login/authenticate as
- Can be set from the CLI via the ``--user`` or ``-u`` options. - Can be set from the CLI via the C(--user) or C(-u) options.
vars: vars:
- name: ansible_user - name: ansible_user
- name: ansible_ssh_user - name: ansible_ssh_user
@ -47,7 +47,7 @@ DOCUMENTATION = """
password: password:
description: description:
- Secret used to either login the ssh server or as a passphrase for ssh keys that require it - Secret used to either login the ssh server or as a passphrase for ssh keys that require it
- Can be set from the CLI via the ``--ask-pass`` option. - Can be set from the CLI via the C(--ask-pass) option.
vars: vars:
- name: ansible_password - name: ansible_password
- name: ansible_ssh_pass - name: ansible_ssh_pass

View file

@ -10,11 +10,11 @@ DOCUMENTATION = '''
version_added: "2.4" version_added: "2.4"
short_description: Uses Jinja2 to construct vars and groups based on existing inventory. short_description: Uses Jinja2 to construct vars and groups based on existing inventory.
description: description:
- Uses a YAML configuration file with a valid YAML or ``.config`` extension to define var expressions and group conditionals - Uses a YAML configuration file with a valid YAML or C(.config) extension to define var expressions and group conditionals
- The Jinja2 conditionals that qualify a host for membership. - The Jinja2 conditionals that qualify a host for membership.
- The JInja2 exprpessions are calculated and assigned to the variables - The JInja2 exprpessions are calculated and assigned to the variables
- Only variables already available from previous inventories or the fact cache can be used for templating. - Only variables already available from previous inventories or the fact cache can be used for templating.
- When ``strict`` is False, failed expressions will be ignored (assumes vars were missing). - When I(strict) is False, failed expressions will be ignored (assumes vars were missing).
extends_documentation_fragment: extends_documentation_fragment:
- constructed - constructed
''' '''

View file

@ -10,7 +10,7 @@ DOCUMENTATION = """
short_description: Lookup current Ansilbe configuration values short_description: Lookup current Ansilbe configuration values
description: description:
- Retrieves the value of an Ansible configuration setting. - Retrieves the value of an Ansible configuration setting.
- You can use ``ansible-config list`` to see all available settings. - You can use C(ansible-config list) to see all available settings.
options: options:
_terms: _terms:
description: The key(s) to look up description: The key(s) to look up

View file

@ -32,7 +32,7 @@ DOCUMENTATION = '''
connect_string: connect_string:
description: description:
- Can be any valid MongoDB connection string, supporting authentication, replicasets, etc. - Can be any valid MongoDB connection string, supporting authentication, replicasets, etc.
- "More info at https://docs.mongodb.org/manual/reference/connection-string/" - "More info at U(https://docs.mongodb.org/manual/reference/connection-string/)"
default: "mongodb://localhost/" default: "mongodb://localhost/"
database: database:
description: description: