mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -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,8 +9,7 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: taiga_issue
|
||||
short_description: Creates/deletes an issue in a Taiga Project Management Platform
|
||||
description:
|
||||
|
@ -89,10 +88,11 @@ options:
|
|||
author: Alejandro Guirao (@lekum)
|
||||
requirements: [python-taiga]
|
||||
notes:
|
||||
- The authentication is achieved either by the environment variable TAIGA_TOKEN or by the pair of environment variables TAIGA_USERNAME and TAIGA_PASSWORD
|
||||
'''
|
||||
- The authentication is achieved either by the environment variable E(TAIGA_TOKEN) or by the pair
|
||||
of environment variables E(TAIGA_USERNAME) and E(TAIGA_PASSWORD).
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create an issue in the my hosted Taiga environment and attach an error log
|
||||
community.general.taiga_issue:
|
||||
taiga_host: https://mytaigahost.example.com
|
||||
|
@ -117,9 +117,9 @@ EXAMPLES = '''
|
|||
subject: An error has been found
|
||||
issue_type: Bug
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''# '''
|
||||
RETURN = """# """
|
||||
import traceback
|
||||
|
||||
from os import getenv
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue