fix plugin-to-doc naming mismatch, typos, grammar (#36366)

This commit is contained in:
Alex Ratner 2018-02-26 23:25:28 +01:00 committed by scottb
parent 9c81b5d92b
commit c2feab0606

View file

@ -6,25 +6,25 @@ from __future__ import (absolute_import, division, print_function)
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = """ DOCUMENTATION = """
lookup: file lookup: lines
author: Daniel Hokka Zakrisson <daniel@hozac.com> author: Daniel Hokka Zakrisson <daniel@hozac.com>
version_added: "0.9" version_added: "0.9"
short_description: read lines from command short_description: read lines from command
description: description:
- Run a commandi or more and split the output into lines returning them as a list - Run one or more commands and split the output into lines, returning them as a list
options: options:
_terms: _terms:
description: command(s) to run description: command(s) to run
required: True required: True
notes: notes:
- Like all lookups this runs on the Ansible controller and is unaffected by other keywords, such as become, - Like all lookups, this runs on the Ansible controller and is unaffected by other keywords such as 'become'.
so if you need to different permissions you must change the command or run Ansible as another user. If you need to use different permissions, you must change the command or run Ansible as another user.
- Alternatively you can use a shell/command task that runs against localhost and registers the result. - Alternatively, you can use a shell/command task that runs against localhost and registers the result.
""" """
EXAMPLES = """ EXAMPLES = """
- name: we could use file direclty, but this shows output from command - name: We could read the file directly, but this shows output from command
debug: msg="{{ item }} is a line running cat on /etc/motd" debug: msg="{{ item }} is an output line from running cat on /etc/motd"
with_lines: cat /etc/motd with_lines: cat /etc/motd
- name: More useful example of looping over a command result - name: More useful example of looping over a command result