internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-08 06:12:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[PR #6681/45eb1e39 backport][stable-7] Use semantic markup (modules o-p) (#6705)

Browse Source 
Use semantic markup (modules o-p) (#6681)

* Use semantic markup.

* Use real option, not alias.

* E() now works better.

(cherry picked from commit 45eb1e3915)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot]
2023-06-15 19:05:01 +02:00
committed by GitHub
parent f583dbd2d3
commit f4af31b76b
42 changed files with 420 additions and 419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/modules/pipx_info.py
View File

@@ -37,7 +37,7 @@ options:
include_raw:
description:
- Returns the raw output of C(pipx list --json).
- The raw output is not affected by I(include_deps) or I(include_injected).
- The raw output is not affected by O(include_deps) or O(include_injected).
type: bool
default: false
executable:
@@ -51,7 +51,7 @@ notes:
- This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip).
- This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module.
- >
This module will honor C(pipx) environment variables such as but not limited to C(PIPX_HOME) and C(PIPX_BIN_DIR)
This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR)
passed using the R(environment Ansible keyword, playbooks_environment).
- This module requires C(pipx) version 0.16.2.1 or above.
- Please note that C(pipx) requires Python 3.6 or above.
@@ -98,20 +98,20 @@ application:
type: str
sample: "3.24.0"
dependencies:
description: The dependencies of the installed application, when I(include_deps=true).
description: The dependencies of the installed application, when O(include_deps=true).
returned: success
type: list
elements: str
sample: ["virtualenv"]
injected:
description: The injected packages for the installed application, when I(include_injected=true).
description: The injected packages for the installed application, when O(include_injected=true).
returned: success
type: dict
sample:
licenses: "0.6.1"
raw_output:
description: The raw output of the C(pipx list) command, when I(include_raw=true). Used for debugging.
description: The raw output of the C(pipx list) command, when O(include_raw=true). Used for debugging.
returned: success
type: dict