mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-09 18:04:02 -07:00
Port ansible doc for plugins to use DOCUMENTATION variables
* Using docstrings conflicts with the standard use of docstrings * PYTHON_OPTIMIZE=2 will omit docstrings. Using docstrings makes future changes to the plugin and module code subject to the requirement that we ensure it won't be run with optimization.
This commit is contained in:
parent
9bc330c89b
commit
cc343a4376
68 changed files with 368 additions and 412 deletions
|
@ -1,8 +1,9 @@
|
|||
# Copyright (c) 2017 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
'''
|
||||
DOCUMENTATION:
|
||||
DOCUMENTATION = '''
|
||||
inventory: ini
|
||||
version_added: "2.4"
|
||||
short_description: Uses an Ansible INI file as inventory source.
|
||||
|
@ -19,8 +20,9 @@ DOCUMENTATION:
|
|||
notes:
|
||||
- It takes the place of the previously hardcoded INI inventory.
|
||||
- To function it requires being whitelisted in configuration.
|
||||
'''
|
||||
|
||||
EXAMPLES:
|
||||
EXAMPLES = '''
|
||||
example1: |
|
||||
# example cfg file
|
||||
[web]
|
||||
|
@ -63,8 +65,6 @@ EXAMPLES:
|
|||
host4 # same host as above, but member of 2 groups, will inherit vars from both
|
||||
# inventory hostnames are unique
|
||||
'''
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import ast
|
||||
import re
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue