mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-03-27 05:43:09 +00:00
[PR #10422/710c02ec backport][stable-11] tasks_only callback: add result_format_callback docs fragment (#10578)
tasks_only callback: add result_format_callback docs fragment (#10422)
Add result_format_callback docs fragment.
(cherry picked from commit 710c02ec01)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
2
changelogs/fragments/10422-tasks_only-result_format.yml
Normal file
2
changelogs/fragments/10422-tasks_only-result_format.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
minor_changes:
|
||||
- "tasks_only callback plugin - add ``result_format`` and ``pretty_results`` options similarly to the default callback (https://github.com/ansible-collections/community.general/pull/10422)."
|
||||
@@ -17,7 +17,8 @@ description:
|
||||
- Can be used to generate output for documentation examples.
|
||||
For this, the O(number_of_columns) option should be set to an explicit value.
|
||||
extends_documentation_fragment:
|
||||
- default_callback
|
||||
- ansible.builtin.default_callback
|
||||
- ansible.builtin.result_format_callback
|
||||
options:
|
||||
number_of_columns:
|
||||
description:
|
||||
@@ -25,6 +26,12 @@ options:
|
||||
type: int
|
||||
env:
|
||||
- name: ANSIBLE_COLLECTIONS_TASKS_ONLY_NUMBER_OF_COLUMNS
|
||||
result_format:
|
||||
# Part of the ansible.builtin.result_format_callback doc fragment
|
||||
version_added: 11.2.0
|
||||
pretty_results:
|
||||
# Part of the ansible.builtin.result_format_callback doc fragment
|
||||
version_added: 11.2.0
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
|
||||
Reference in New Issue
Block a user