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:
Dag Wieers 2018-03-15 22:15:24 +01:00 committed by GitHub
parent 58eb2e849d
commit cdd21e2170
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1458 additions and 9114 deletions

View file

@ -46,7 +46,6 @@ options:
- Configures the device platform network operating system. This value is
used to load a device specific netconf plugin. If this option is not
configured, then the default netconf plugin will be used.
default: null
vars:
- name: ansible_network_os
remote_user:
@ -88,14 +87,14 @@ options:
timeout seconds, an error is generated.
default: 120
host_key_auto_add:
type: boolean
type: bool
description:
- By default, Ansible will prompt the user before adding SSH keys to the
known hosts file. Enabling this option, unknown host keys will
automatically be added to the known hosts file.
- Be sure to fully understand the security implications of enabling this
option on production systems as it could create a security vulnerability.
default: False
default: 'no'
ini:
section: paramiko_connection
key: host_key_auto_add

View file

@ -41,7 +41,6 @@ options:
- Configures the device platform network operating system. This value is
used to load the correct terminal and cliconf plugins to communicate
with the remote device
default: null
vars:
- name: ansible_network_os
remote_user:

View file

@ -150,7 +150,6 @@ DOCUMENTATION = '''
- name: ansible_ssh_private_key_file
control_path:
default: null
description:
- This is the location to save ssh's ControlPath sockets, it uses ssh's variable substitution.
- Since 2.3, if null, ansible will generate a unique hash. Use `%(directory)s` to indicate where to use the control dir path setting.
@ -170,12 +169,12 @@ DOCUMENTATION = '''
- section: ssh_connection
key: control_path_dir
sftp_batch_mode:
default: True
default: 'yes'
description: 'TODO: write it'
env: [{name: ANSIBLE_SFTP_BATCH_MODE}]
ini:
- {key: sftp_batch_mode, section: ssh_connection}
type: boolean
type: bool
scp_if_ssh:
default: smart
description:
@ -187,12 +186,12 @@ DOCUMENTATION = '''
- {key: scp_if_ssh, section: ssh_connection}
use_tty:
version_added: '2.5'
default: True
default: 'yes'
description: add -tt to ssh commands to force tty allocation
env: [{name: ANSIBLE_SSH_USETTY}]
ini:
- {key: usetty, section: ssh_connection}
type: boolean
type: bool
yaml: {key: connection.usetty}
'''