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 <[email protected]> * docs: shorten the long lines --------- Co-authored-by: Felix Fontein <[email protected]>
ansible-collections · May 20, 2024 · 4792e21 · 4792e21
1 parent 95e5097
commit 4792e21
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/plugins/callback/yaml.py b/plugins/callback/yaml.py
@@ -19,6 +19,16 @@
       - 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
@@ -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
@@ -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