From 9d51e05cfb6568ab87bd95b6665c2c3054007942 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 20 May 2024 17:23:41 +0200 Subject: [PATCH] [stable-7] docs: add seealso and notes for yaml callback plugin (#8396) (#8399) 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 (cherry picked from commit 4792e21416f681758df00ca85bf05abc6e56e03b) Co-authored-by: kurokobo --- 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 8dae95713c..e8b3f16f52 100644 --- a/tests/sanity/ignore-2.13.txt +++ b/tests/sanity/ignore-2.13.txt @@ -1,4 +1,5 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen +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.py validate-modules:doc-missing-type diff --git a/tests/sanity/ignore-2.14.txt b/tests/sanity/ignore-2.14.txt index 135d5260e5..7bbb04cad5 100644 --- a/tests/sanity/ignore-2.14.txt +++ b/tests/sanity/ignore-2.14.txt @@ -1,4 +1,5 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen +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.py validate-modules:doc-missing-type