summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Martz <matt@sivel.net>2024-11-05 00:06:58 +0100
committerGitHub <noreply@github.com>2024-11-05 00:06:58 +0100
commitabf6036bb23fcec5864fed1667e31b417f563df4 (patch)
tree6bc9aeeeff3505d7eff62dcfd7258c6999f9b5db
parenttest: fix check_required_by (#84153) (diff)
downloadansible-abf6036bb23fcec5864fed1667e31b417f563df4.tar.xz
ansible-abf6036bb23fcec5864fed1667e31b417f563df4.zip
Link to role argspec docs. Fixes #84164 (#84192)
-rw-r--r--lib/ansible/modules/validate_argument_spec.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/ansible/modules/validate_argument_spec.py b/lib/ansible/modules/validate_argument_spec.py
index 8c75e8abb4..aa9fc00802 100644
--- a/lib/ansible/modules/validate_argument_spec.py
+++ b/lib/ansible/modules/validate_argument_spec.py
@@ -16,7 +16,8 @@ version_added: "2.11"
options:
argument_spec:
description:
- - A dictionary like AnsibleModule argument_spec. See R(argument spec definition,argument_spec).
+ - A dictionary like AnsibleModule argument_spec.
+ - See the C(options) parameter for the R(specification format,role_argument_spec).
required: true
provided_arguments:
description:
@@ -46,6 +47,8 @@ attributes:
support: none
platform:
platforms: all
+notes:
+ - It is unnecessary to call this module explicitly if the role contains an R(argument spec,role_argument_spec).
"""
EXAMPLES = r"""