Skip to content

Commit

Permalink
Update DOCUMENTATION.yml (ansible#80579)
Browse files Browse the repository at this point in the history
  • Loading branch information
EstherChristopher authored Apr 20, 2023
1 parent 791510c commit a4fb670
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions examples/DOCUMENTATION.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
# See https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html for more information
#
module: modulename
short_description: This is a sentence describing the module
short_description: This is a short phrase describing the module
description:
- Longer description of the module.
- You might include instructions.
version_added: "X.Y"
author: "Your AWESOME name (@awesome-github-id)"
deprecated: "X.5"
options:
# One or more of the following
option_name:
Expand All @@ -21,13 +22,15 @@ options:
default: a string or the word null
choices:
- enable
- disable
- disable
aliases:
- repo_name
version_added: "1.X"
notes:
- Other things consumers of your module should know.
requirements:
- list of required things.
- list of required things
- 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

0 comments on commit a4fb670

Please sign in to comment.