mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-04 07:24:00 -07:00
[PR #10433/69d479f0 backport][stable-11] doc style adjustments: modules [lm]* (#10438)
Some checks failed
EOL CI / EOL Sanity (Ⓐ2.16) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Has been cancelled
nox / Run extra sanity tests (push) Has been cancelled
Some checks failed
EOL CI / EOL Sanity (Ⓐ2.16) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Has been cancelled
nox / Run extra sanity tests (push) Has been cancelled
doc style adjustments: modules [lm]* (#10433)
* doc style adjustments: modules l*
* doc style adjustments: modules m*
* Apply suggestions from code review
* Update plugins/modules/logstash_plugin.py
---------
(cherry picked from commit 69d479f06c
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
eab6f4c6ff
commit
5c7feec6f7
33 changed files with 214 additions and 168 deletions
|
@ -23,7 +23,7 @@ attributes:
|
|||
check_mode:
|
||||
support: partial
|
||||
details:
|
||||
- The script will not be executed in check mode.
|
||||
- The script is not be executed in check mode.
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
|
@ -64,8 +64,8 @@ options:
|
|||
version_added: 8.4.0
|
||||
output:
|
||||
description:
|
||||
- With V(default) each row will be returned as a list of values. See RV(query_results).
|
||||
- Output format V(dict) will return dictionary with the column names as keys. See RV(query_results_dict).
|
||||
- With V(default) each row is returned as a list of values. See RV(query_results).
|
||||
- Output format V(dict) returns dictionary with the column names as keys. See RV(query_results_dict).
|
||||
- V(dict) requires named columns to be returned by each query otherwise an error is thrown.
|
||||
choices: ["dict", "default"]
|
||||
default: 'default'
|
||||
|
@ -170,12 +170,33 @@ query_results:
|
|||
type: list
|
||||
elements: list
|
||||
returned: success and O(output=default)
|
||||
sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
|
||||
sample:
|
||||
[
|
||||
[
|
||||
[
|
||||
[
|
||||
"Batch 0 - Select 0"
|
||||
]
|
||||
],
|
||||
[
|
||||
[
|
||||
"Batch 0 - Select 1"
|
||||
]
|
||||
]
|
||||
],
|
||||
[
|
||||
[
|
||||
[
|
||||
"Batch 1 - Select 0"
|
||||
]
|
||||
]
|
||||
]
|
||||
]
|
||||
contains:
|
||||
queries:
|
||||
description:
|
||||
- List of result sets of each query.
|
||||
- If a query returns no results, the results of this and all the following queries will not be included in the output.
|
||||
- If a query returns no results, the results of this and all the following queries are not included in the output.
|
||||
- Use the V(GO) keyword in O(script) to separate queries.
|
||||
type: list
|
||||
elements: list
|
||||
|
@ -197,12 +218,33 @@ query_results_dict:
|
|||
type: list
|
||||
elements: list
|
||||
returned: success and O(output=dict)
|
||||
sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
|
||||
sample:
|
||||
[
|
||||
[
|
||||
[
|
||||
[
|
||||
"Batch 0 - Select 0"
|
||||
]
|
||||
],
|
||||
[
|
||||
[
|
||||
"Batch 0 - Select 1"
|
||||
]
|
||||
]
|
||||
],
|
||||
[
|
||||
[
|
||||
[
|
||||
"Batch 1 - Select 0"
|
||||
]
|
||||
]
|
||||
]
|
||||
]
|
||||
contains:
|
||||
queries:
|
||||
description:
|
||||
- List of result sets of each query.
|
||||
- If a query returns no results, the results of this and all the following queries will not be included in the output.
|
||||
- If a query returns no results, the results of this and all the following queries are not included in the output.
|
||||
Use V(GO) keyword to separate queries.
|
||||
type: list
|
||||
elements: list
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue