[prox ... pyth]*: normalize docs (#9364)

* [prox ... pyth]*: normalize docs

* Apply suggestions from code review

Co-authored-by: IamLunchbox <56757745+IamLunchbox@users.noreply.github.com>

* Update plugins/modules/pushbullet.py

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

* Update plugins/modules/pushbullet.py

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

---------

Co-authored-by: IamLunchbox <56757745+IamLunchbox@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-26 20:24:16 +13:00 committed by GitHub
parent 9fc3092bb3
commit 6b7ea3443d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 633 additions and 729 deletions

View file

@ -7,7 +7,7 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r"""
module: python_requirements_info
short_description: Show python path and assert dependency versions
description:
@ -19,18 +19,17 @@ options:
dependencies:
type: list
elements: str
description: >
A list of version-likes or module names to check for installation.
Supported operators: <, >, <=, >=, or ==. The bare module name like
V(ansible), the module with a specific version like V(boto3==1.6.1), or a
partial version like V(requests>2) are all valid specifications.
description:
- 'A list of version-likes or module names to check for installation. Supported operators: C(<), C(>), C(<=), C(>=), or C(==).'
- The bare module name like V(ansible), the module with a specific version like V(boto3==1.6.1),
or a partial version like V(requests>2) are all valid specifications.
default: []
author:
- Will Thames (@willthames)
- Ryan Scott Brown (@ryansb)
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Show python lib/site paths
community.general.python_requirements_info:
@ -39,21 +38,21 @@ EXAMPLES = '''
dependencies:
- boto3>1.6
- botocore<2
'''
"""
RETURN = '''
RETURN = r"""
python:
description: path to python version used
description: Path to the Python interpreter used.
returned: always
type: str
sample: /usr/local/opt/python@2/bin/python2.7
python_version:
description: version of python
description: Version of Python.
returned: always
type: str
sample: "2.7.15 (default, May 1 2018, 16:44:08)\n[GCC 4.2.1 Compatible Apple LLVM 9.1.0 (clang-902.0.39.1)]"
python_version_info:
description: breakdown version of python
description: Breakdown version of Python.
returned: always
type: dict
contains:
@ -84,25 +83,26 @@ python_version_info:
sample: 0
version_added: 4.2.0
python_system_path:
description: List of paths python is looking for modules in
description: List of paths Python is looking for modules in.
returned: always
type: list
sample:
- /usr/local/opt/python@2/site-packages/
- /usr/lib/python/site-packages/
valid:
description: A dictionary of dependencies that matched their desired versions. If no version was specified, then RV(ignore:desired) will be null
description: A dictionary of dependencies that matched their desired versions. If no version was specified, then RV(ignore:desired) will be
null.
returned: always
type: dict
sample:
boto3:
desired: null
desired:
installed: 1.7.60
botocore:
desired: botocore<2
installed: 1.10.60
mismatched:
description: A dictionary of dependencies that did not satisfy the desired version
description: A dictionary of dependencies that did not satisfy the desired version.
returned: always
type: dict
sample:
@ -110,13 +110,13 @@ mismatched:
desired: botocore>2
installed: 1.10.60
not_found:
description: A list of packages that could not be imported at all, and are not installed
description: A list of packages that could not be imported at all, and are not installed.
returned: always
type: list
sample:
- boto4
- requests
'''
"""
import re
import sys