Mention check mode in attribute description.

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
ansible-collections · Dec 30, 2024 · 6f687d9 · 6f687d9
1 parent de3aeea
commit 6f687d9
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/plugins/doc_fragments/attributes.py b/plugins/doc_fragments/attributes.py
@@ -20,7 +20,7 @@ class ModuleDocFragment(object):
     description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
   idempotent:
     description:
-      - When run twice in a row with the same arguments, the second invocation indicates no change.
+      - When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.
       - This assumes that the system controlled/queried by the module has not changed in a relevant way.
 """
 

diff --git a/roles/install/meta/argument_specs.yml b/roles/install/meta/argument_specs.yml
@@ -84,7 +84,7 @@ argument_specs:
           - The role supports diff mode if the M(ansible.builtin.package) action for the system supports it.
       idempotent:
         description:
-          - When run twice in a row with the same arguments, the second invocation indicates no change.
+          - When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.
           - This assumes that the system controlled/queried by the module has not changed in a relevant way.
         support: partial
         details: