From 770430fd071ce4adf068a9acbe7558198baedf34 Mon Sep 17 00:00:00 2001 From: Satyajit Bulage Date: Thu, 5 Dec 2019 01:53:45 +0530 Subject: [PATCH] Added required parameter to document DOC-string to produce Documentation. (#65230) * Added required parameter to document DOC-string to produce Documentation. Signed-off-by: Satyajit Bulage * Just copy short_description as it was --- lib/ansible/modules/files/template.py | 1 + lib/ansible/modules/windows/win_template.py | 1 + lib/ansible/plugins/doc_fragments/template_common.py | 1 - 3 files changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/ansible/modules/files/template.py b/lib/ansible/modules/files/template.py index 949c800ce69..1aec5226b8f 100644 --- a/lib/ansible/modules/files/template.py +++ b/lib/ansible/modules/files/template.py @@ -17,6 +17,7 @@ DOCUMENTATION = r''' --- module: template version_added: historical +short_description: Template a file out to a remote server options: follow: description: diff --git a/lib/ansible/modules/windows/win_template.py b/lib/ansible/modules/windows/win_template.py index dff65320a98..bd8b2492fa6 100644 --- a/lib/ansible/modules/windows/win_template.py +++ b/lib/ansible/modules/windows/win_template.py @@ -13,6 +13,7 @@ DOCUMENTATION = r''' --- module: win_template version_added: "1.9.2" +short_description: Template a file out to a remote server options: backup: description: diff --git a/lib/ansible/plugins/doc_fragments/template_common.py b/lib/ansible/plugins/doc_fragments/template_common.py index bf997ff744d..47b61e74c0c 100644 --- a/lib/ansible/plugins/doc_fragments/template_common.py +++ b/lib/ansible/plugins/doc_fragments/template_common.py @@ -11,7 +11,6 @@ class ModuleDocFragment(object): # Standard template documentation fragment, use by template and win_template. DOCUMENTATION = r''' -short_description: Template a file out to a remote server description: - Templates are processed by the L(Jinja2 templating language,http://jinja.pocoo.org/docs/). - Documentation on the template formatting can be found in the