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
commit 283fee90a7
7 changed files with 169 additions and 154 deletions

View file

@ -7,37 +7,38 @@ 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: import_playbook
short_description: import a playbook.
short_description: Import a playbook
description:
- Includes a file with a list of plays to be executed.
- Files with a list of plays can only be included at the top level, you cannot use this action inside a Play.
- Includes a file with a list of plays to be executed.
- Files with a list of plays can only be included at the top level. You cannot use this action inside a play.
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.
- The name of the imported playbook is specified directly without any other option.
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 Ansible, rather than a module, and cannot be overridden like a module.
'''
EXAMPLES = """
- name: include a play after another play
hosts: localhost
- hosts: localhost
tasks:
- debug:
msg: "play1"
msg: play1
- import_playbook: otherplays.yml
- name: Include a play after another play
import_playbook: otherplays.yaml
- name: This DOES NOT WORK
@ -46,10 +47,10 @@ EXAMPLES = """
- debug:
msg: task1
- name: This failes because I'm inside a play already
import_playbook: stuff.yml
- name: This fails because I'm inside a play already
import_playbook: stuff.yaml
"""
RETURN = """
# this module does not return anything except plays to execute
# This module does not return anything except plays to execute.
"""