mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-29 03:30:22 -07:00
ma*.py: normalize docs (#9389)
* ma*.py: normalize docs * Update plugins/modules/matrix.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
a99f72fc36
commit
a9fca56374
17 changed files with 596 additions and 639 deletions
|
@ -12,54 +12,54 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: macports
|
||||
author: "Jimmy Tang (@jcftang)"
|
||||
short_description: Package manager for MacPorts
|
||||
description:
|
||||
- Manages MacPorts packages (ports)
|
||||
- Manages MacPorts packages (ports).
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- A list of port names.
|
||||
aliases: ['port']
|
||||
type: list
|
||||
elements: str
|
||||
selfupdate:
|
||||
description:
|
||||
- Update Macports and the ports tree, either prior to installing ports or as a separate step.
|
||||
- Equivalent to running C(port selfupdate).
|
||||
aliases: ['update_cache', 'update_ports']
|
||||
default: false
|
||||
type: bool
|
||||
state:
|
||||
description:
|
||||
- Indicates the desired state of the port.
|
||||
choices: [ 'present', 'absent', 'active', 'inactive', 'installed', 'removed']
|
||||
default: present
|
||||
type: str
|
||||
upgrade:
|
||||
description:
|
||||
- Upgrade all outdated ports, either prior to installing ports or as a separate step.
|
||||
- Equivalent to running C(port upgrade outdated).
|
||||
default: false
|
||||
type: bool
|
||||
variant:
|
||||
description:
|
||||
- A port variant specification.
|
||||
- 'O(variant) is only supported with O(state=installed) and O(state=present).'
|
||||
aliases: ['variants']
|
||||
type: str
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
name:
|
||||
description:
|
||||
- A list of port names.
|
||||
aliases: ['port']
|
||||
type: list
|
||||
elements: str
|
||||
selfupdate:
|
||||
description:
|
||||
- Update Macports and the ports tree, either prior to installing ports or as a separate step.
|
||||
- Equivalent to running C(port selfupdate).
|
||||
aliases: ['update_cache', 'update_ports']
|
||||
default: false
|
||||
type: bool
|
||||
state:
|
||||
description:
|
||||
- Indicates the desired state of the port.
|
||||
choices: ['present', 'absent', 'active', 'inactive', 'installed', 'removed']
|
||||
default: present
|
||||
type: str
|
||||
upgrade:
|
||||
description:
|
||||
- Upgrade all outdated ports, either prior to installing ports or as a separate step.
|
||||
- Equivalent to running C(port upgrade outdated).
|
||||
default: false
|
||||
type: bool
|
||||
variant:
|
||||
description:
|
||||
- A port variant specification.
|
||||
- O(variant) is only supported with O(state=installed) and O(state=present).
|
||||
aliases: ['variants']
|
||||
type: str
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
- name: Install the foo port
|
||||
community.general.macports:
|
||||
name: foo
|
||||
|
@ -74,8 +74,8 @@ EXAMPLES = '''
|
|||
name: "{{ ports }}"
|
||||
vars:
|
||||
ports:
|
||||
- foo
|
||||
- foo-tools
|
||||
- foo
|
||||
- foo-tools
|
||||
|
||||
- name: Update Macports and the ports tree, then upgrade all outdated ports
|
||||
community.general.macports:
|
||||
|
@ -101,7 +101,7 @@ EXAMPLES = '''
|
|||
community.general.macports:
|
||||
name: foo
|
||||
state: inactive
|
||||
'''
|
||||
"""
|
||||
|
||||
import re
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue