From 183aa6ed6b18018334b5fcd0f52859c4a26c43df Mon Sep 17 00:00:00 2001
From: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Date: Thu, 13 Nov 2025 23:47:08 +1300
Subject: [PATCH] fix markup (#11147)

* fix markup for common return values

* Apply suggestion from review
---
 plugins/modules/ansible_galaxy_install.py              | 2 +-
 plugins/modules/bitbucket_pipeline_variable.py         | 2 +-
 plugins/modules/cpanm.py                               | 6 +++---
 plugins/modules/filesize.py                            | 2 +-
 plugins/modules/heroku_collaborator.py                 | 2 +-
 plugins/modules/keycloak_user_execute_actions_email.py | 2 +-
 plugins/modules/lxc_container.py                       | 2 +-
 plugins/modules/one_template.py                        | 2 +-
 plugins/modules/one_vnet.py                            | 2 +-
 plugins/modules/pacman.py                              | 4 ++--
 plugins/modules/pagerduty_change.py                    | 2 +-
 plugins/modules/puppet.py                              | 2 +-
 plugins/modules/scaleway_container.py                  | 2 +-
 plugins/modules/scaleway_container_namespace.py        | 2 +-
 plugins/modules/scaleway_function.py                   | 2 +-
 plugins/modules/scaleway_function_namespace.py         | 2 +-
 plugins/modules/snmp_facts.py                          | 2 +-
 17 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/plugins/modules/ansible_galaxy_install.py b/plugins/modules/ansible_galaxy_install.py
index b2e371f482..dbdc9683e4 100644
--- a/plugins/modules/ansible_galaxy_install.py
+++ b/plugins/modules/ansible_galaxy_install.py
@@ -81,7 +81,7 @@ options:
   force:
     description:
       - Force overwriting existing roles and/or collections.
-      - It can be used for upgrading, but the module output always reports C(changed=true).
+      - It can be used for upgrading, but the module output always reports RV(ignore:changed=true).
       - Using O(force=true) is mandatory when downgrading.
     type: bool
     default: false
diff --git a/plugins/modules/bitbucket_pipeline_variable.py b/plugins/modules/bitbucket_pipeline_variable.py
index a1a8bfca00..0c61bbc98b 100644
--- a/plugins/modules/bitbucket_pipeline_variable.py
+++ b/plugins/modules/bitbucket_pipeline_variable.py
@@ -55,7 +55,7 @@ options:
     choices: [absent, present]
 notes:
   - Check mode is supported.
-  - For secured values return parameter C(changed) is always V(true).
+  - For secured values return parameter RV(ignore:changed) is always V(true).
 """
 
 EXAMPLES = r"""
diff --git a/plugins/modules/cpanm.py b/plugins/modules/cpanm.py
index d176783dbe..13a4e9989a 100644
--- a/plugins/modules/cpanm.py
+++ b/plugins/modules/cpanm.py
@@ -69,16 +69,16 @@ options:
       - If V(false), it ensures the dependencies declared as suggests are not installed, overriding any decision made earlier
         in E(PERL_CPANM_OPT).
       - If parameter is not set, C(cpanm) uses its existing defaults.
-      - When these dependencies fail to install, cpanm continues the installation, since they are just suggestion.
+      - When these dependencies fail to install, C(cpanm) continues the installation, since they are just suggestions.
     type: bool
     version_added: 10.3.0
   version:
     description:
-      - Version specification for the perl module. When O(mode) is V(new), C(cpanm) version operators are accepted.
+      - Version specification for the perl module. When O(mode=new), C(cpanm) version operators are accepted.
     type: str
   executable:
     description:
-      - Override the path to the cpanm executable.
+      - Override the path to the C(cpanm) executable.
     type: path
   mode:
     description:
diff --git a/plugins/modules/filesize.py b/plugins/modules/filesize.py
index 7ab199bad1..2102e34a44 100644
--- a/plugins/modules/filesize.py
+++ b/plugins/modules/filesize.py
@@ -66,7 +66,7 @@ options:
   force:
     description:
       - Whether or not to overwrite the file if it exists, in other words, to truncate it from 0. When V(true), the module
-        is not idempotent, that means it always reports C(changed=true).
+        is not idempotent, that means it always reports RV(ignore:changed=true).
       - O(force=true) and O(sparse=true) are mutually exclusive.
     type: bool
     default: false
diff --git a/plugins/modules/heroku_collaborator.py b/plugins/modules/heroku_collaborator.py
index cdd16f11d3..a91c9c7ed9 100644
--- a/plugins/modules/heroku_collaborator.py
+++ b/plugins/modules/heroku_collaborator.py
@@ -54,7 +54,7 @@ options:
     default: "present"
 notes:
   - E(HEROKU_API_KEY) and E(TF_VAR_HEROKU_API_KEY) environment variables can be used instead setting O(api_key).
-  - If you use C(check_mode), you can also pass the C(-v) flag to see affected apps in C(msg), for example C(["heroku-example-app"]).
+  - If you use C(check_mode), you can also pass the C(-v) flag to see affected apps in RV(ignore:msg), for example C(["heroku-example-app"]).
 """
 
 EXAMPLES = r"""
diff --git a/plugins/modules/keycloak_user_execute_actions_email.py b/plugins/modules/keycloak_user_execute_actions_email.py
index cb1a78cb38..1ec2a2ebde 100644
--- a/plugins/modules/keycloak_user_execute_actions_email.py
+++ b/plugins/modules/keycloak_user_execute_actions_email.py
@@ -18,7 +18,7 @@ description:
     This sends an email with one or more required actions the user must complete (for example resetting the password).
   - If no O(actions) list is provided, the default action C(UPDATE_PASSWORD) is used.
   - You must supply either the user's O(id) or O(username). Supplying only C(username) causes an extra lookup call.
-  - This module always reports C(changed=true) because sending an email is a side effect and cannot be made idempotent.
+  - This module always reports RV(ignore:changed=true) because sending an email is a side effect and cannot be made idempotent.
 attributes:
   check_mode:
     support: full
diff --git a/plugins/modules/lxc_container.py b/plugins/modules/lxc_container.py
index ee24ce89cf..c21e65ec0e 100644
--- a/plugins/modules/lxc_container.py
+++ b/plugins/modules/lxc_container.py
@@ -174,7 +174,7 @@ notes:
     the command executed, and then the container V(stopped) again. Likewise if O(state=stopped) and the container does not
     exist it is first created, V(started), the command executed, and then V(stopped). If you use a C(|) in the variable you
     can use common script formatting within the variable itself. The O(container_command) option always execute as C(bash).
-    When using O(container_command), a log file is created in the C(/tmp/) directory which contains both C(stdout) and C(stderr)
+    When using O(container_command), a log file is created in the C(/tmp/) directory which contains both RV(ignore:stdout) and RV(ignore:stderr)
     of any command executed.
   - If O(archive=true) the system attempts to create a compressed tarball of the running container. The O(archive) option
     supports LVM backed containers and creates a snapshot of the running container when creating the archive.
diff --git a/plugins/modules/one_template.py b/plugins/modules/one_template.py
index 1059ee2752..2f3167f46f 100644
--- a/plugins/modules/one_template.py
+++ b/plugins/modules/one_template.py
@@ -23,7 +23,7 @@ attributes:
   check_mode:
     support: partial
     details:
-      - Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually
+      - Note that check mode always returns RV(ignore:changed=true) for existing templates, even if the template would not actually
         change.
   diff_mode:
     support: none
diff --git a/plugins/modules/one_vnet.py b/plugins/modules/one_vnet.py
index 39f3bf4120..c99ad75562 100644
--- a/plugins/modules/one_vnet.py
+++ b/plugins/modules/one_vnet.py
@@ -20,7 +20,7 @@ attributes:
   check_mode:
     support: partial
     details:
-      - Note that check mode always returns C(changed=true) for existing networks, even if the network would not actually
+      - Note that check mode always returns RV(ignore:changed=true) for existing networks, even if the network would not actually
         change.
   diff_mode:
     support: none
diff --git a/plugins/modules/pacman.py b/plugins/modules/pacman.py
index d9fa599c43..cb2160b989 100644
--- a/plugins/modules/pacman.py
+++ b/plugins/modules/pacman.py
@@ -82,7 +82,7 @@ options:
       - Whether or not to refresh the master package lists.
       - This can be run as part of a package installation or as a separate step.
       - If not specified, it defaults to V(false).
-      - Please note that this option only had an influence on the module's C(changed) state if O(name) and O(upgrade) are
+      - Please note that this option only had an influence on the module's RV(ignore:changed) state if O(name) and O(upgrade) are
         not specified before community.general 5.0.0. See the examples for how to keep the old behavior.
     type: bool
 
@@ -128,7 +128,7 @@ notes:
   - 'In the tests, while using C(yay) as the O(executable) option, the module failed to install AUR packages with the error:
     C(error: target not found: <pkg>). This is caused by an incompatibility of yay with the arguments passed by this module.
     See L(yay bug #1744 report for details, https://github.com/Jguer/yay/issues/1744).'
-  - The common return values C(stdout) and C(stderr) are returned upon success, when needed, since community.general 4.1.0.
+  - The common return values RV(ignore:stdout) and RV(ignore:stderr) are returned upon success, when needed, since community.general 4.1.0.
 """
 
 RETURN = r"""
diff --git a/plugins/modules/pagerduty_change.py b/plugins/modules/pagerduty_change.py
index 6207f40283..64f0ef6c8d 100644
--- a/plugins/modules/pagerduty_change.py
+++ b/plugins/modules/pagerduty_change.py
@@ -23,7 +23,7 @@ attributes:
   check_mode:
     support: full
     details:
-      - Check mode simply does nothing except returning C(changed=true) in case the O(url) seems to be correct.
+      - Check mode simply does nothing except returning RV(ignore:changed=true) in case the O(url) seems to be correct.
   diff_mode:
     support: none
 options:
diff --git a/plugins/modules/puppet.py b/plugins/modules/puppet.py
index ddc2116fd2..c997ba138c 100644
--- a/plugins/modules/puppet.py
+++ b/plugins/modules/puppet.py
@@ -65,7 +65,7 @@ options:
     description:
       - Where the puppet logs should go, if puppet apply is being used.
       - V(all) goes to both C(console) and C(syslog).
-      - V(stdout) is deprecated and replaced by C(console).
+      - V(stdout) is deprecated and replaced by C(console).  # TODO which/where is console?
     type: str
     choices: [all, stdout, syslog]
     default: stdout
diff --git a/plugins/modules/scaleway_container.py b/plugins/modules/scaleway_container.py
index d759d12fab..7289d54849 100644
--- a/plugins/modules/scaleway_container.py
+++ b/plugins/modules/scaleway_container.py
@@ -90,7 +90,7 @@ options:
   secret_environment_variables:
     description:
       - Secret environment variables of the container namespace.
-      - Updating those values does not output a C(changed) state in Ansible.
+      - Updating those values does not output a RV(ignore:changed) state in Ansible.
       - Injected in container at runtime.
     type: dict
     default: {}
diff --git a/plugins/modules/scaleway_container_namespace.py b/plugins/modules/scaleway_container_namespace.py
index b2b2ce2e22..150eaa4e76 100644
--- a/plugins/modules/scaleway_container_namespace.py
+++ b/plugins/modules/scaleway_container_namespace.py
@@ -80,7 +80,7 @@ options:
   secret_environment_variables:
     description:
       - Secret environment variables of the container namespace.
-      - Updating those values does not output a C(changed) state in Ansible.
+      - Updating those values does not output a RV(ignore:changed) state in Ansible.
       - Injected in containers at runtime.
     type: dict
     default: {}
diff --git a/plugins/modules/scaleway_function.py b/plugins/modules/scaleway_function.py
index c6e998f51e..9c6a0f64e0 100644
--- a/plugins/modules/scaleway_function.py
+++ b/plugins/modules/scaleway_function.py
@@ -90,7 +90,7 @@ options:
   secret_environment_variables:
     description:
       - Secret environment variables of the function.
-      - Updating those values does not output a C(changed) state in Ansible.
+      - Updating those values does not output a RV(ignore:changed) state in Ansible.
       - Injected in function at runtime.
     type: dict
     default: {}
diff --git a/plugins/modules/scaleway_function_namespace.py b/plugins/modules/scaleway_function_namespace.py
index 2f981ca154..e69929a18a 100644
--- a/plugins/modules/scaleway_function_namespace.py
+++ b/plugins/modules/scaleway_function_namespace.py
@@ -80,7 +80,7 @@ options:
   secret_environment_variables:
     description:
       - Secret environment variables of the function namespace.
-      - Updating those values does not output a C(changed) state in Ansible.
+      - Updating those values does not output a RV(ignore:changed) state in Ansible.
       - Injected in functions at runtime.
     type: dict
     default: {}
diff --git a/plugins/modules/snmp_facts.py b/plugins/modules/snmp_facts.py
index e7d730f9bd..7ea53c85be 100644
--- a/plugins/modules/snmp_facts.py
+++ b/plugins/modules/snmp_facts.py
@@ -13,7 +13,7 @@ author:
   - Patrick Ogenstad (@ogenstad)
 short_description: Retrieve facts for a device using SNMP
 description:
-  - Retrieve facts for a device using SNMP, the facts are inserted to the C(ansible_facts) key.
+  - Retrieve facts for a device using SNMP, the facts are inserted to the RV(ignore:ansible_facts) key.
 requirements:
   - pysnmp
 extends_documentation_fragment: