plugins: Doc improvement (#41378)

* Typo fixes
* Grammer fixes
* Option fixes

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/35713/merge
Abhijeet Kasurde 7 years ago committed by GitHub
parent d6ba139713
commit 063d19048d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -30,7 +30,7 @@ DOCUMENTATION = """
default: utf-8 default: utf-8
version_added: "2.1" version_added: "2.1"
notes: notes:
- The default is for TSV files (tab delimeted) not CSV (comma delimted) ... yes the name is misleading. - The default is for TSV files (tab delimited) not CSV (comma delimited) ... yes the name is misleading.
""" """
EXAMPLES = """ EXAMPLES = """

@ -24,7 +24,7 @@ DOCUMENTATION = '''
- Jan-Piet Mens (@jpmens) - Jan-Piet Mens (@jpmens)
lookup: etcd lookup: etcd
version_added: "2.1" version_added: "2.1"
short_description: get info from etcd server short_description: get info from an etcd server
description: description:
- Retrieves data from an etcd server - Retrieves data from an etcd server
options: options:
@ -48,7 +48,7 @@ DOCUMENTATION = '''
- name: ANSIBLE_ETCD_VERSION - name: ANSIBLE_ETCD_VERSION
validate_certs: validate_certs:
description: description:
- toggle checking that the ssl ceritificates are valid, you normally only want to turn this off with self-signed certs. - toggle checking that the ssl certificates are valid, you normally only want to turn this off with self-signed certs.
default: True default: True
type: boolean type: boolean
''' '''

@ -29,7 +29,7 @@ EXAMPLES = """
RETURN = """ RETURN = """
_raw: _raw:
description: description:
- list with each item.0 giving you the postiion and item.1 the value - list with each item.0 giving you the position and item.1 the value
type: list type: list
""" """

@ -14,14 +14,14 @@ DOCUMENTATION = """
version_added: "1.3" version_added: "1.3"
short_description: list of inventory hosts matching a host pattern short_description: list of inventory hosts matching a host pattern
description: description:
- "This lookup understands 'host patterns' as used bye the `hosts:` keyword in plays - "This lookup understands 'host patterns' as used by the `hosts:` keyword in plays
and can return a list of matching hosts from inventory" and can return a list of matching hosts from inventory"
notes: notes:
- this is only worth for 'hostname patterns' it is easier to loop over the group/group_names variables otherwise. - this is only worth for 'hostname patterns' it is easier to loop over the group/group_names variables otherwise.
""" """
EXAMPLES = """ EXAMPLES = """
- name: show all the hosts matching the pattern, ie all but the group www - name: show all the hosts matching the pattern, i.e. all but the group www
debug: debug:
msg: "{{ item }}" msg: "{{ item }}"
with_inventory_hostnames: with_inventory_hostnames:

@ -14,7 +14,7 @@ DOCUMENTATION = """
notes: notes:
- this is the standard lookup used for loops in most examples - this is the standard lookup used for loops in most examples
- check out the 'flattened' lookup for recursive flattening - check out the 'flattened' lookup for recursive flattening
- if you dont want flattening nor any other tranformation look at the 'list' lookup. - if you do not want flattening nor any other transformation look at the 'list' lookup.
options: options:
_terms: _terms:
description: list of items description: list of items

@ -54,7 +54,7 @@ DOCUMENTATION = '''
default: "{}" default: "{}"
skip: skip:
description: description:
- How many results should be skept - How many results should be skipped
type: integer type: integer
limit: limit:
description: description:
@ -66,7 +66,7 @@ DOCUMENTATION = '''
type: list type: list
default: "[]" default: "[]"
notes: notes:
- "Please check https://api.mongodb.org/python/current/api/pymongo/collection.html?highlight=find#pymongo.collection.Collection.find for more detais." - "Please check https://api.mongodb.org/python/current/api/pymongo/collection.html?highlight=find#pymongo.collection.Collection.find for more details."
requirements: requirements:
- pymongo >= 2.4 (python library) - pymongo >= 2.4 (python library)
''' '''

@ -32,7 +32,7 @@ DOCUMENTATION = """
description: increments between sequence numbers, the default is 1 unless the end is less than the start, then it is -1. description: increments between sequence numbers, the default is 1 unless the end is less than the start, then it is -1.
type: number type: number
format: format:
description: return a string with the generated number formated in description: return a string with the generated number formatted in
""" """
EXAMPLES = """ EXAMPLES = """

@ -11,10 +11,9 @@ DOCUMENTATION = """
short_description: read keys from Python shelve file short_description: read keys from Python shelve file
description: description:
- Read keys from Python shelve file. - Read keys from Python shelve file.
optoins: options:
_terms: _terms:
description: sets of key value pairs of parameters description: sets of key value pairs of parameters
options:
key: key:
description: key to query description: key to query
required: True required: True

@ -5,14 +5,14 @@ from __future__ import (absolute_import, division, print_function)
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = """ DOCUMENTATION = """
lookup: toghether lookup: together
author: Bradley Young <young.bradley@gmail.com> author: Bradley Young <young.bradley@gmail.com>
version_added: '1.3' version_added: '1.3'
short_description: merges lists into syncronized list short_description: merges lists into synchronized list
description: description:
- Creates a list with the iterated elements of the supplied lists - Creates a list with the iterated elements of the supplied lists
- "To clarify with an example, [ 'a', 'b' ] and [ 1, 2 ] turn into [ ('a',1), ('b', 2) ]" - "To clarify with an example, [ 'a', 'b' ] and [ 1, 2 ] turn into [ ('a',1), ('b', 2) ]"
- This is basicaly the same as the 'zip_longest' filter and Python function - This is basically the same as the 'zip_longest' filter and Python function
- Any 'unbalanced' elements will be substituted with 'None' - Any 'unbalanced' elements will be substituted with 'None'
options: options:
_terms: _terms:
@ -31,7 +31,7 @@ EXAMPLES = """
RETURN = """ RETURN = """
_list: _list:
description: syncronized list description: synchronized list
""" """
from ansible.errors import AnsibleError from ansible.errors import AnsibleError
from ansible.module_utils.six.moves import zip_longest from ansible.module_utils.six.moves import zip_longest

Loading…
Cancel
Save