From 4792e21416f681758df00ca85bf05abc6e56e03b Mon Sep 17 00:00:00 2001 From: kurokobo Date: Mon, 20 May 2024 22:40:05 +0900 Subject: [PATCH] docs: add seealso and notes for yaml callback plugin (#8396) * docs: add seealso and notes for yaml callback plugin * docs: correct links to parameters Co-authored-by: Felix Fontein * docs: shorten the long lines --------- Co-authored-by: Felix Fontein --- plugins/callback/yaml.py | 10 ++++++++++ tests/sanity/ignore-2.13.txt | 1 + tests/sanity/ignore-2.14.txt | 1 + 3 files changed, 12 insertions(+) diff --git a/plugins/callback/yaml.py b/plugins/callback/yaml.py index ae2c8f8810..e41f69ec53 100644 --- a/plugins/callback/yaml.py +++ b/plugins/callback/yaml.py @@ -19,6 +19,16 @@ DOCUMENTATION = ''' - default_callback requirements: - set as stdout in configuration + seealso: + - plugin: ansible.builtin.default + plugin_type: callback + description: > + There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback) + that allows you to change the output format to YAML. + notes: + - > + With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format) + in P(ansible.builtin.default#callback). ''' import yaml diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt index cfeaff7c31..6f6495dd17 100644 --- a/tests/sanity/ignore-2.13.txt +++ b/tests/sanity/ignore-2.13.txt @@ -1,5 +1,6 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen plugins/callback/timestamp.py validate-modules:invalid-documentation +plugins/callback/yaml.py validate-modules:invalid-documentation plugins/lookup/etcd.py validate-modules:invalid-documentation plugins/lookup/etcd3.py validate-modules:invalid-documentation plugins/modules/consul_session.py validate-modules:parameter-state-invalid-choice diff --git a/tests/sanity/ignore-2.14.txt b/tests/sanity/ignore-2.14.txt index 247d43fe37..24d7521036 100644 --- a/tests/sanity/ignore-2.14.txt +++ b/tests/sanity/ignore-2.14.txt @@ -1,5 +1,6 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen plugins/callback/timestamp.py validate-modules:invalid-documentation +plugins/callback/yaml.py validate-modules:invalid-documentation plugins/lookup/etcd.py validate-modules:invalid-documentation plugins/lookup/etcd3.py validate-modules:invalid-documentation plugins/modules/consul_session.py validate-modules:parameter-state-invalid-choice