Skip to content

Commit

Permalink
Added required parameter to document DOC-string to produce Documentat…
Browse files Browse the repository at this point in the history
…ion. (#65230)

* Added required parameter to document DOC-string to produce Documentation.

Signed-off-by: Satyajit Bulage <sbulage@redhat.com>

* Just copy short_description as it was
  • Loading branch information
sbulage authored and jborean93 committed Dec 4, 2019
1 parent c04fc52 commit 770430f
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions lib/ansible/modules/files/template.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
---
module: template
version_added: historical
short_description: Template a file out to a remote server
options:
follow:
description:
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/windows/win_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
---
module: win_template
version_added: "1.9.2"
short_description: Template a file out to a remote server
options:
backup:
description:
Expand Down
1 change: 0 additions & 1 deletion lib/ansible/plugins/doc_fragments/template_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 770430f

Please sign in to comment.