Unifying wording and formatting of all include and import modules (#31938)

* Unifying wording and formatting of all include and import modules

* Changes based on comments from dharmabumstead

* Removed instances of the term ‘Ansible Engine’

* Removed instances of term ‘Ansible Engine’

* Updated term

* Updated wording

* Updated wording

* Removed the term ‘Ansible Engine’
This commit is contained in:
Jiri Tyr 2017-11-22 22:05:29 +00:00 committed by scottb
parent 496ce388ab
commit 283fee90a7
7 changed files with 169 additions and 154 deletions

View file

@ -7,51 +7,52 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'core'}
ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'core'
}
DOCUMENTATION = '''
---
author:
- "Ansible Core Team (@ansible)"
author: Ansible Core Team (@ansible)
module: include_tasks
short_description: dynamically include a task list.
short_description: Dynamically include a task list
description:
- Includes a file with a list of tasks to be executed in the current playbook.
- Includes a file with a list of tasks to be executed in the current playbook.
version_added: "2.4"
options:
free-form:
description:
- This action allows you to specify the name of the file directly w/o any other options.
- Unlike M(import_tasks) this action will be affected by most keywords, including loops and conditionals.
- The name of the imported file is specified directly without any other option.
- Unlike M(import_tasks), most keywords, including loops and conditionals, apply to this statement.
notes:
- This is really not a module, this is a feature of the Ansible Engine, as such it cannot be overridden the same way a module can.
- This is a core feature of the Ansible, rather than a module, and cannot be overridden like a module.
'''
EXAMPLES = """
# include task list in play
- hosts: all
tasks:
- debug:
msg: task1
- include_tasks: stuff.yml
- name: Include task list in play
include_tasks: stuff.yaml
- debug:
msg: task10
# dyanmic include task list in play
- hosts: all
tasks:
- debug:
msg: task1
- include_tasks: "{{ hostvar }}.yml"
- name: Include task list in play only if the condition is true
include_tasks: "{{ hostvar }}.yaml"
when: hostvar is defined
"""
RETURN = """
# this module does not return anything except tasks to execute
# This module does not return anything except tasks to execute.
"""