Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The Module format and documentation guide is missing the description for positional #2345

Open
numo68 opened this issue Jan 13, 2025 · 3 comments
Labels
new_contributor This PR is the first contribution by a new community member.

Comments

@numo68
Copy link

numo68 commented Jan 13, 2025

The Documentation fields part of https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html does not mention the positional key, that - at least to the reviewer that reviewed my contribution - is needed at least for filters.

The docs checkers also insisted on specifying the name, not module. Maybe the whole schema might benefit from reviewing.

Thanks

@ansible-documentation-bot ansible-documentation-bot bot added needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. labels Jan 13, 2025
@ansible-documentation-bot
Copy link
Contributor

Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the dawgs-meeting tag to a forum topic to bring it up at the next meeting.

@samccann samccann removed the needs_triage Needs a first human triage before being processed. label Jan 14, 2025
@samccann
Copy link
Contributor

Thanks @numo68 for opening the issue!

For reference, this is the comment from @felixfontein

@felixfontein
Copy link
Collaborator

Note that positional is only available for lookup, filter, and test plugins, not for any other plugin type, or for modules.

The documentation linked above is mostly written for modules, not for other plugin types. Many parts are also true for other plugin types, but not everything that's needed or allowed for plugins is mentioned there.

At some point we need to refactor these documentations to make clear what's correct for which module/plugin type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new_contributor This PR is the first contribution by a new community member.
Projects
Status: 🆕 Triage
Development

No branches or pull requests

3 participants