mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
[PR #9339/6e84c137 backport][stable-9] t*: normalize docs (#9355)
t*: normalize docs (#9339)
* t*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* break long line to regain sanity
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 6e84c1375e
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
8031011497
commit
e120c64a21
6 changed files with 109 additions and 134 deletions
|
@ -9,12 +9,11 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: typetalk
|
||||
short_description: Send a message to typetalk
|
||||
description:
|
||||
- Send a message to typetalk using typetalk API
|
||||
- Send a message to typetalk using typetalk API.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
|
@ -26,35 +25,35 @@ options:
|
|||
client_id:
|
||||
type: str
|
||||
description:
|
||||
- OAuth2 client ID
|
||||
- OAuth2 client ID.
|
||||
required: true
|
||||
client_secret:
|
||||
type: str
|
||||
description:
|
||||
- OAuth2 client secret
|
||||
- OAuth2 client secret.
|
||||
required: true
|
||||
topic:
|
||||
type: int
|
||||
description:
|
||||
- topic id to post message
|
||||
- Topic id to post message.
|
||||
required: true
|
||||
msg:
|
||||
type: str
|
||||
description:
|
||||
- message body
|
||||
- Message body.
|
||||
required: true
|
||||
requirements: [ json ]
|
||||
requirements: [json]
|
||||
author: "Takashi Someda (@tksmd)"
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Send a message to typetalk
|
||||
community.general.typetalk:
|
||||
client_id: 12345
|
||||
client_secret: 12345
|
||||
topic: 1
|
||||
msg: install completed
|
||||
'''
|
||||
"""
|
||||
|
||||
import json
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue