Looking at this page in the documentation. The description of “entry-point-name → author” says to “Use a multi-line list if there is more than one author.” What exactly is a “multi-line list”? Should it be an actual list, containing mutliple strings? argument_specs : main : author : …

It should be a string if there is 1 author, and a list for multiple. I’m guessing the multi-line recommendation is to deter from a comma-separated name1, name1 or bracketed list [name1, name2] for readability.

I’ll take your word for it. I’m not familiar enough with the code to know where to find the code which parses this file. This is yet another case where Ansible’s documentation is lacking. Actually, there’s another question: is there a way to manually TEST the contents of this file? Other than just…

@shertel for below topic? [image] How to compare RPM versions Get Help Is there a test, similar to ansible.builtin.version, which knows how to compare RPM version strings, using the same algorithm that the rpm and yum commands use? Or even better, the problem I’m hoping…

I’m not aware of any validation for authors in role argument spec. The argspec options are validated against the available variables when running the role. Here’s the action plugin that parses the file ansible.builtin.validate_argument_spec module – Validate role argument specs. — Ansible Documenta…

Assuming the role is part of a collection: antsibull-docs lint-collection-docs does validation on the argument spec. Ansible-lint also validates it, it probably also work with stand-alone roles outside collections.

I created a PR to improve the docs: Improve role argspec documentation by felixfontein · Pull Request #1126 · ansible/ansible-documentation · GitHub (More infos on antsibull-docs lint-collection-docs: Creating a collection docsite - antsibull-docs – Ansible Documentation Build Scripts )

Clarify documentation - argument_specs.yml "author" - list or string?

Get Help

akira6592 (Akira Yokochi) February 14, 2024, 3:35pm 5

@shertel

for below topic?

Topic		Replies	Views
Generating a role's argument_specs.yml based on defaults Get Help role	4	1429	January 5, 2024
How to correctly specify AnsibleModule sub specs Ansible Developer	1	50	July 28, 2017
Generate docs from ansible argspec Ansible Project	2	120	November 2, 2022
Are module, role and play argument validation the same? (argument_spec) Get Help playbook , role , module	7	100	February 23, 2026
Documenting roles Collection Development documentation , role	5	527	August 9, 2025

Clarify documentation - argument_specs.yml "author" - list or string?

Related topics