ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-28 03:00:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

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

Browse source 
* [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
Download patch file Download diff file Expand all files Collapse all files

35
plugins/modules/pipx_info.py
View file

@ -9,46 +9,44 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
---
DOCUMENTATION = r"""
module: pipx_info
short_description: Rretrieves information about applications installed with pipx
version_added: 5.6.0
description:
- Retrieve details about Python applications installed in isolated virtualenvs using pipx.
- Retrieve details about Python applications installed in isolated virtualenvs using pipx.
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes.info_module
- community.general.pipx
- community.general.attributes
- community.general.attributes.info_module
- community.general.pipx
options:
name:
description:
- Name of an application installed with C(pipx).
- Name of an application installed with C(pipx).
type: str
include_deps:
description:
- Include dependent packages in the output.
- Include dependent packages in the output.
type: bool
default: false
include_injected:
description:
- Include injected packages in the output.
- Include injected packages in the output.
type: bool
default: false
include_raw:
description:
- Returns the raw output of C(pipx list --json).
- The raw output is not affected by O(include_deps) or O(include_injected).
- Returns the raw output of C(pipx list --json).
- The raw output is not affected by O(include_deps) or O(include_injected).
type: bool
default: false
global:
version_added: 9.3.0
author:
- "Alexei Znamensky (@russoz)"
- "Alexei Znamensky (@russoz)"
"""
EXAMPLES = """
---
EXAMPLES = r"""
- name: retrieve all installed applications
community.general.pipx_info: {}
@ -68,10 +66,9 @@ EXAMPLES = """
include_deps: true
"""
RETURN = """
---
RETURN = r"""
application:
description: The list of installed applications
description: The list of installed applications.
returned: success
type: list
elements: dict
@ -100,8 +97,8 @@ application:
licenses: "0.6.1"
pinned:
description:
- Whether the installed application is pinned or not.
- When using C(pipx<=1.6.0), this returns C(null).
- Whether the installed application is pinned or not.
- When using C(pipx<=1.6.0), this returns C(null).
returned: success
type: bool
sample: