mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 13:50:22 -07:00
[PR #6683/eff0cb0e backport][stable-7] Use semantic markup (modules r-s) (#6707)
Use semantic markup (modules r-s) (#6683)
* Use semantic markup.
* Use 'ignore:' for alias reference.
* Ignore sanity errors for older ansible-core versions.
* Improve markup for RHSM modules.
Co-authored-by: Pino Toscano <ptoscano@redhat.com>
* 'ignore:' is no longer needed.
* E() now works better.
---------
Co-authored-by: Pino Toscano <ptoscano@redhat.com>
(cherry picked from commit eff0cb0ed9
)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
f4af31b76b
commit
34c4b1f367
49 changed files with 311 additions and 303 deletions
|
@ -33,13 +33,13 @@ options:
|
|||
key:
|
||||
description:
|
||||
- The column name used as a key for the resulting dictionary.
|
||||
- If C(key) is unset, the module returns a list of dictionaries,
|
||||
- If O(key) is unset, the module returns a list of dictionaries,
|
||||
where each dictionary is a row in the CSV file.
|
||||
type: str
|
||||
dialect:
|
||||
description:
|
||||
- The CSV dialect to use when parsing the CSV file.
|
||||
- Possible values include C(excel), C(excel-tab) or C(unix).
|
||||
- Possible values include V(excel), V(excel-tab) or V(unix).
|
||||
type: str
|
||||
default: excel
|
||||
fieldnames:
|
||||
|
@ -50,29 +50,31 @@ options:
|
|||
elements: str
|
||||
unique:
|
||||
description:
|
||||
- Whether the C(key) used is expected to be unique.
|
||||
- Whether the O(key) used is expected to be unique.
|
||||
type: bool
|
||||
default: true
|
||||
delimiter:
|
||||
description:
|
||||
- A one-character string used to separate fields.
|
||||
- When using this parameter, you change the default value used by I(dialect).
|
||||
- When using this parameter, you change the default value used by O(dialect).
|
||||
- The default value depends on the dialect used.
|
||||
type: str
|
||||
skipinitialspace:
|
||||
description:
|
||||
- Whether to ignore any whitespaces immediately following the delimiter.
|
||||
- When using this parameter, you change the default value used by I(dialect).
|
||||
- When using this parameter, you change the default value used by O(dialect).
|
||||
- The default value depends on the dialect used.
|
||||
type: bool
|
||||
strict:
|
||||
description:
|
||||
- Whether to raise an exception on bad CSV input.
|
||||
- When using this parameter, you change the default value used by I(dialect).
|
||||
- When using this parameter, you change the default value used by O(dialect).
|
||||
- The default value depends on the dialect used.
|
||||
type: bool
|
||||
notes:
|
||||
- Ansible also ships with the C(csvfile) lookup plugin, which can be used to do selective lookups in CSV files from Jinja.
|
||||
seealso:
|
||||
- plugin: community.general.csvfile
|
||||
plugin_type: lookup
|
||||
description: Can be used to do selective lookups in CSV files from Jinja.
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue