mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 13:52:54 +00: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:
@@ -48,20 +48,17 @@ options:
|
||||
description:
|
||||
- "The email address for the registry account. NOTE: private registries may not require this,
|
||||
but Docker Hub requires it."
|
||||
default: None
|
||||
reauthorize:
|
||||
required: False
|
||||
description:
|
||||
- Refresh exiting authentication found in the configuration file.
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases:
|
||||
- reauth
|
||||
config_path:
|
||||
description:
|
||||
- Custom path to the Docker CLI configuration file.
|
||||
default: ~/.docker/config.json
|
||||
required: False
|
||||
aliases:
|
||||
- self.config_path
|
||||
- dockercfg_path
|
||||
@@ -74,7 +71,6 @@ options:
|
||||
- docker does not support 'logout' with a custom config file.
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
required: False
|
||||
|
||||
extends_documentation_fragment:
|
||||
- docker
|
||||
|
||||
Reference in New Issue
Block a user