mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -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
|
@ -34,36 +34,27 @@ options:
|
|||
list_all:
|
||||
description:
|
||||
- List all settings (optionally limited to a given I(scope))
|
||||
required: false
|
||||
choices: [ "yes", "no" ]
|
||||
default: no
|
||||
type: bool
|
||||
default: 'no'
|
||||
name:
|
||||
description:
|
||||
- The name of the setting. If no value is supplied, the value will
|
||||
be read from the config if it has been set.
|
||||
required: false
|
||||
default: null
|
||||
repo:
|
||||
description:
|
||||
- Path to a git repository for reading and writing values from a
|
||||
specific repo.
|
||||
required: false
|
||||
default: null
|
||||
scope:
|
||||
description:
|
||||
- Specify which scope to read/set values from. This is required
|
||||
when setting config values. If this is set to local, you must
|
||||
also specify the repo parameter. It defaults to system only when
|
||||
not using I(list_all)=yes.
|
||||
required: false
|
||||
choices: [ "local", "global", "system" ]
|
||||
default: null
|
||||
value:
|
||||
description:
|
||||
- When specifying the name of a single setting, supply a value to
|
||||
set that setting to the given value.
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue