diff options
author | Toshio Kuratomi <a.badger@gmail.com> | 2017-09-08 11:08:31 -0700 |
---|---|---|
committer | Toshio Kuratomi <a.badger@gmail.com> | 2017-09-11 18:34:09 -0700 |
commit | cc343a4376a27927e0c7d31862dbb3108e101978 (patch) | |
tree | aa2f036b3054e17cd74ac8d208cb396b5b342c19 /lib/ansible/plugins/vars | |
parent | 9bc330c89b96be4482d5ab7d054ca43262ed7eb2 (diff) | |
download | ansible-cc343a4376a27927e0c7d31862dbb3108e101978.tar.gz |
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.
Diffstat (limited to 'lib/ansible/plugins/vars')
-rw-r--r-- | lib/ansible/plugins/vars/host_group_vars.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/lib/ansible/plugins/vars/host_group_vars.py b/lib/ansible/plugins/vars/host_group_vars.py index bc4fd0a9dd..66c059b263 100644 --- a/lib/ansible/plugins/vars/host_group_vars.py +++ b/lib/ansible/plugins/vars/host_group_vars.py @@ -15,8 +15,10 @@ # You should have received a copy of the GNU General Public License # along with Ansible. If not, see <http://www.gnu.org/licenses/>. ############################################# -''' -DOCUMENTATION: +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +DOCUMENTATION = ''' vars: host_group_vars version_added: "2.4" short_description: In charge of loading group_vars and host_vars @@ -41,9 +43,6 @@ DOCUMENTATION: type: list ''' -from __future__ import (absolute_import, division, print_function) -__metaclass__ = type - import os from ansible import constants as C from ansible.errors import AnsibleParserError |