mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-30 04:00:21 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -37,47 +37,42 @@ options:
|
|||
path:
|
||||
description:
|
||||
- "':' separated list of paths to search for 'brew' executable."
|
||||
required: false
|
||||
default: '/usr/local/bin'
|
||||
state:
|
||||
description:
|
||||
- state of the cask
|
||||
choices: [ 'present', 'absent', 'upgraded' ]
|
||||
required: false
|
||||
default: present
|
||||
update_homebrew:
|
||||
description:
|
||||
- update homebrew itself first. Note that C(brew cask update) is
|
||||
a synonym for C(brew update).
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases: ['update-brew']
|
||||
version_added: "2.2"
|
||||
install_options:
|
||||
description:
|
||||
- options flags to install a package
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['options']
|
||||
version_added: "2.2"
|
||||
accept_external_apps:
|
||||
description:
|
||||
- allow external apps
|
||||
required: false
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5.0"
|
||||
upgrade_all:
|
||||
description:
|
||||
- upgrade all casks (mutually exclusive with `upgrade`)
|
||||
required: False
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5.0"
|
||||
upgrade:
|
||||
description:
|
||||
- upgrade all casks (mutually exclusive with `upgrade_all`)
|
||||
required: False
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5.0"
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue