[pi ... prof]*: normalize docs (#9371)

* [pi ... prof]*: normalize docs

* Update plugins/modules/pkg5_publisher.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-26 10:48:04 +13:00 committed by GitHub
parent 23d97fa4b0
commit 13e2097f37
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 702 additions and 766 deletions

View file

@ -8,45 +8,42 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
---
DOCUMENTATION = r"""
module: pritunl_user_info
author: "Florian Dambrine (@Lowess)"
version_added: 2.3.0
short_description: List Pritunl Users using the Pritunl API
description:
- A module to list Pritunl users using the Pritunl API.
- A module to list Pritunl users using the Pritunl API.
extends_documentation_fragment:
- community.general.pritunl
- community.general.attributes
- community.general.attributes.info_module
- community.general.pritunl
- community.general.attributes
- community.general.attributes.info_module
options:
organization:
type: str
required: true
aliases:
- org
description:
- The name of the organization the user is part of.
user_name:
type: str
required: false
description:
- Name of the user to filter on Pritunl.
user_type:
type: str
required: false
default: client
choices:
- client
- server
description:
- Type of the user O(user_name).
organization:
type: str
required: true
aliases:
- org
description:
- The name of the organization the user is part of.
user_name:
type: str
required: false
description:
- Name of the user to filter on Pritunl.
user_type:
type: str
required: false
default: client
choices:
- client
- server
description:
- Type of the user O(user_name).
"""
EXAMPLES = """
EXAMPLES = r"""
- name: List all existing users part of the organization MyOrg
community.general.pritunl_user_info:
state: list
@ -59,7 +56,7 @@ EXAMPLES = """
user_name: Florian
"""
RETURN = """
RETURN = r"""
users:
description: List of Pritunl users.
returned: success