diff options
| author | Esther Christopher <estheradamuchris@gmail.com> | 2023-04-20 20:03:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-20 15:03:09 -0400 |
| commit | a4fb670e9c43d9bcc9c1ed0b235514f7bcf32af2 (patch) | |
| tree | 7908068ef4c256d84e7a9cbc613f06df5e8604f4 /examples/DOCUMENTATION.yml | |
| parent | 791510ccba5f3a9af3d22f442e9d4d10b1129a00 (diff) | |
| download | ansible-a4fb670e9c43d9bcc9c1ed0b235514f7bcf32af2.tar.gz | |
Update DOCUMENTATION.yml (#80579)
Diffstat (limited to 'examples/DOCUMENTATION.yml')
| -rw-r--r-- | examples/DOCUMENTATION.yml | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/examples/DOCUMENTATION.yml b/examples/DOCUMENTATION.yml index 86d577affc..b6ccb86629 100644 --- a/examples/DOCUMENTATION.yml +++ b/examples/DOCUMENTATION.yml @@ -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: @@ -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 |