mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-04 15:34:01 -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
|
@ -24,34 +24,27 @@ options:
|
|||
server:
|
||||
description:
|
||||
- IRC server name/address
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
- IRC server port number
|
||||
required: false
|
||||
default: 6667
|
||||
nick:
|
||||
description:
|
||||
- Nickname to send the message from. May be shortened, depending on server's NICKLEN setting.
|
||||
required: false
|
||||
default: ansible
|
||||
msg:
|
||||
description:
|
||||
- The message body.
|
||||
required: true
|
||||
default: null
|
||||
topic:
|
||||
description:
|
||||
- Set the channel topic
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.0"
|
||||
color:
|
||||
description:
|
||||
- Text color for the message. ("none" is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not "none").
|
||||
Added 11 more colors in version 2.0.
|
||||
required: false
|
||||
default: "none"
|
||||
choices: [ "none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", "light_cyan",
|
||||
"light_blue", "pink", "gray", "light_gray"]
|
||||
|
@ -62,18 +55,14 @@ options:
|
|||
nick_to:
|
||||
description:
|
||||
- A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the message will be sent to both of them.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.0"
|
||||
key:
|
||||
description:
|
||||
- Channel key
|
||||
required: false
|
||||
version_added: "1.7"
|
||||
passwd:
|
||||
description:
|
||||
- Server password
|
||||
required: false
|
||||
timeout:
|
||||
description:
|
||||
- Timeout to use while waiting for successful registration and join
|
||||
|
@ -83,19 +72,19 @@ options:
|
|||
use_ssl:
|
||||
description:
|
||||
- Designates whether TLS/SSL should be used when connecting to the IRC server
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "1.8"
|
||||
part:
|
||||
description:
|
||||
- Designates whether user should part from channel after sending message or not.
|
||||
Useful for when using a faux bot and not wanting join/parts between messages.
|
||||
default: True
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "2.0"
|
||||
style:
|
||||
description:
|
||||
- Text style for the message. Note italic does not work on some clients
|
||||
default: None
|
||||
required: False
|
||||
choices: [ "bold", "underline", "reverse", "italic" ]
|
||||
version_added: "2.0"
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue