Minor fixes (#25059)

1) Examples: Remove double space between "option:" and "value"
2) Documentation: Fix rendering usses
3) Documentation: Remove `required: true` to match argspec
This commit is contained in:
John R Barker 2017-05-26 15:17:08 +01:00 committed by GitHub
commit 3740ad2828
27 changed files with 287 additions and 291 deletions

View file

@ -52,7 +52,6 @@ options:
by the configured retries, the task fails. See examples. by the configured retries, the task fails. See examples.
required: false required: false
default: null default: null
aliases: ['waitfor']
match: match:
description: description:
- The I(match) argument is used in conjunction with the - The I(match) argument is used in conjunction with the
@ -201,7 +200,7 @@ def main():
# { command: <str>, output: <str>, prompt: <str>, response: <str> } # { command: <str>, output: <str>, prompt: <str>, response: <str> }
commands=dict(type='list', required=True), commands=dict(type='list', required=True),
wait_for=dict(type='list', aliases=['waitfor']), wait_for=dict(type='list'),
match=dict(default='all', choices=['any', 'all']), match=dict(default='all', choices=['any', 'all']),
retries=dict(default=10, type='int'), retries=dict(default=10, type='int'),

View file

@ -32,8 +32,8 @@ author:
- Zhijin Zhou (@CloudEngine-Ansible) - Zhijin Zhou (@CloudEngine-Ansible)
notes: notes:
- The relevant configurations will be deleted if DLDP is disabled using enable=disable. - The relevant configurations will be deleted if DLDP is disabled using enable=disable.
- When using auth_mode=none, it will restore the default DLDP authentication mode(By default, - When using auth_mode=none, it will restore the default DLDP authentication mode. By default,
DLDP packets are not authenticated.). DLDP packets are not authenticated.
- By default, the working mode of DLDP is enhance, so you are advised to use work_mode=enhance to restore defualt - By default, the working mode of DLDP is enhance, so you are advised to use work_mode=enhance to restore defualt
DLDP working mode. DLDP working mode.
- The default interval for sending Advertisement packets is 5 seconds, so you are advised to use time_interval=5 to - The default interval for sending Advertisement packets is 5 seconds, so you are advised to use time_interval=5 to

View file

@ -57,18 +57,18 @@ options:
description: description:
- Configures a route distinguisher (RD) for a BD EVPN instance. - Configures a route distinguisher (RD) for a BD EVPN instance.
The format of an RD can be as follows The format of an RD can be as follows
1) 2-byte AS number:4-byte user-defined number, for example, 1:3. An AS number is an integer ranging from - 1) 2-byte AS number:4-byte user-defined number, for example, 1:3. An AS number is an integer ranging from
0 to 65535, and a user-defined number is an integer ranging from 0 to 4294967295. The AS and user-defined 0 to 65535, and a user-defined number is an integer ranging from 0 to 4294967295. The AS and user-defined
numbers cannot be both 0s. This means that an RD cannot be 0:0. numbers cannot be both 0s. This means that an RD cannot be 0:0.
2) Integral 4-byte AS number:2-byte user-defined number, for example, 65537:3. An AS number is an integer - 2) Integral 4-byte AS number:2-byte user-defined number, for example, 65537:3. An AS number is an integer
ranging from 65536 to 4294967295, and a user-defined number is an integer ranging from 0 to 65535. ranging from 65536 to 4294967295, and a user-defined number is an integer ranging from 0 to 65535.
3) 4-byte AS number in dotted notation:2-byte user-defined number, for example, 0.0:3 or 0.1:0. A 4-byte - 3) 4-byte AS number in dotted notation:2-byte user-defined number, for example, 0.0:3 or 0.1:0. A 4-byte
AS number in dotted notation is in the format of x.y, where x and y are integers ranging from 0 to 65535. AS number in dotted notation is in the format of x.y, where x and y are integers ranging from 0 to 65535.
4) A user-defined number is an integer ranging from 0 to 65535. The AS and user-defined numbers cannot be - 4) A user-defined number is an integer ranging from 0 to 65535. The AS and user-defined numbers cannot be
both 0s. This means that an RD cannot be 0.0:0. both 0s. This means that an RD cannot be 0.0:0.
5) 32-bit IP address:2-byte user-defined number. For example, 192.168.122.15:1. An IP address ranges from - 5) 32-bit IP address:2-byte user-defined number. For example, 192.168.122.15:1. An IP address ranges from
0.0.0.0 to 255.255.255.255, and a user-defined number is an integer ranging from 0 to 65535. 0.0.0.0 to 255.255.255.255, and a user-defined number is an integer ranging from 0 to 65535.
6) 'auto' specifies the RD that is automatically generated. - 6) 'auto' specifies the RD that is automatically generated.
required: false required: false
default: null default: null
vpn_target_both: vpn_target_both:

View file

@ -94,8 +94,8 @@ options:
lsaointervalflag: lsaointervalflag:
description: description:
- Specifies whether cancel the interval of LSA originate or not. - Specifies whether cancel the interval of LSA originate or not.
If set the parameter but noe specifies value ,the default will be used. If set the parameter but noe specifies value, the default will be used.
true:cancel the interval of LSA originate,the interval is 0. true:cancel the interval of LSA originate, the interval is 0.
false:do not cancel the interval of LSA originate. false:do not cancel the interval of LSA originate.
required: false required: false
default: False default: False

View file

@ -33,7 +33,6 @@ options:
confirm: confirm:
description: description:
- Safeguard boolean. Set to true if you're sure you want to reboot. - Safeguard boolean. Set to true if you're sure you want to reboot.
required: true
type: bool type: bool
default: false default: false
save_config: save_config:

View file

@ -24,7 +24,7 @@ DOCUMENTATION = '''
--- ---
module: ce_snmp_user module: ce_snmp_user
version_added: "2.4" version_added: "2.4"
short_description: Manages SNMP user configuration. short_description: Manages SNMP user configuration on HUAWEI CloudEngine switches.
description: description:
- Manages SNMP user configurations on CloudEngine switches. - Manages SNMP user configurations on CloudEngine switches.
author: author:

View file

@ -63,8 +63,6 @@ options:
description: description:
- If C(mode=trunk), used as the VLAN range to ADD or REMOVE - If C(mode=trunk), used as the VLAN range to ADD or REMOVE
from the trunk, such as 2-10 or 2,5,10-15, etc. from the trunk, such as 2-10 or 2,5,10-15, etc.
aliases:
- trunk_add_vlans
required: false required: false
default: null default: null
state: state: