Update DOCUMENTATION.yml (#80579)

pull/80589/head
Esther Christopher 2 years ago committed by GitHub
parent 791510ccba
commit a4fb670e9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -5,12 +5,13 @@
# See https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html for more information # See https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html for more information
# #
module: modulename module: modulename
short_description: This is a sentence describing the module short_description: This is a short phrase describing the module
description: description:
- Longer description of the module. - Longer description of the module.
- You might include instructions. - You might include instructions.
version_added: "X.Y" version_added: "X.Y"
author: "Your AWESOME name (@awesome-github-id)" author: "Your AWESOME name (@awesome-github-id)"
deprecated: "X.5"
options: options:
# One or more of the following # One or more of the following
option_name: option_name:
@ -25,9 +26,11 @@ options:
aliases: aliases:
- repo_name - repo_name
version_added: "1.X" version_added: "1.X"
notes:
- Other things consumers of your module should know.
requirements: requirements:
- list of required things. - list of required things
- like the factor package - like the factor package
- zypper >= 1.0 - zypper >= 1.0
seealso:
- specify references to other modules, useful guides, and so on
notes:
- other things consumers of your module should know

Loading…
Cancel
Save