Fix Typos in attribute descriptions

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2021-08-07 19:26:12 +02:00
parent 218a202fa7
commit c54d497b17
Signed by: luzifer
GPG key ID: 0066F03ED215AD7D
2 changed files with 4 additions and 11 deletions

View file

@ -94,7 +94,7 @@ func (m modStreamSchedule) cronUpdateSchedule() {
Description: m.attrs.MustString("embed_description", ptrStringEmpty), Description: m.attrs.MustString("embed_description", ptrStringEmpty),
Fields: []*discordgo.MessageEmbedField{}, Fields: []*discordgo.MessageEmbedField{},
Thumbnail: &discordgo.MessageEmbedThumbnail{ Thumbnail: &discordgo.MessageEmbedThumbnail{
// @attr embed_thumbnail_url optional string "" Publically hosted image URL to u100se as thumbnail // @attr embed_thumbnail_url optional string "" Publically hosted image URL to use as thumbnail
URL: m.attrs.MustString("embed_thumbnail_url", ptrStringEmpty), URL: m.attrs.MustString("embed_thumbnail_url", ptrStringEmpty),
// @attr embed_thumbnail_width optional int64 "" Width of the thumbnail // @attr embed_thumbnail_width optional int64 "" Width of the thumbnail
Width: int(m.attrs.MustInt64("embed_thumbnail_width", ptrInt64Zero)), Width: int(m.attrs.MustInt64("embed_thumbnail_width", ptrInt64Zero)),
@ -102,7 +102,7 @@ func (m modStreamSchedule) cronUpdateSchedule() {
Height: int(m.attrs.MustInt64("embed_thumbnail_height", ptrInt64Zero)), Height: int(m.attrs.MustInt64("embed_thumbnail_height", ptrInt64Zero)),
}, },
Timestamp: time.Now().Format(time.RFC3339), Timestamp: time.Now().Format(time.RFC3339),
// @attr embed_title required string "" Title of the embed (used to find the managed post, must be unique for that channel) // @attr embed_title required string "" Title of the embed
Title: m.attrs.MustString("embed_title", nil), Title: m.attrs.MustString("embed_title", nil),
Type: discordgo.EmbedTypeRich, Type: discordgo.EmbedTypeRich,
} }

View file

@ -106,13 +106,6 @@ Updates the presence status of the bot to display the next stream
| `cron` | | string | `* * * * *` | When to execute the module | | `cron` | | string | `* * * * *` | When to execute the module |
| `schedule_past_time` | | duration | `15m` | How long in the past should the schedule contain an entry | | `schedule_past_time` | | duration | `15m` | How long in the past should the schedule contain an entry |
## Type: `reactionrole`
Creates a post with pre-set reactions and assigns roles on reaction
| Attribute | Req. | Type | Default Value | Description |
| --------- | :--: | ---- | ------------- | ----------- |
## Type: `schedule` ## Type: `schedule`
Posts stream schedule derived from Twitch schedule as embed in Discord channel Posts stream schedule derived from Twitch schedule as embed in Discord channel
@ -120,7 +113,7 @@ Posts stream schedule derived from Twitch schedule as embed in Discord channel
| Attribute | Req. | Type | Default Value | Description | | Attribute | Req. | Type | Default Value | Description |
| --------- | :--: | ---- | ------------- | ----------- | | --------- | :--: | ---- | ------------- | ----------- |
| `discord_channel_id` | ✅ | string | | ID of the Discord channel to post the message to | | `discord_channel_id` | ✅ | string | | ID of the Discord channel to post the message to |
| `embed_title` | ✅ | string | | Title of the embed (used to find the managed post, must be unique for that channel) | | `embed_title` | ✅ | string | | Title of the embed |
| `twitch_channel_id` | ✅ | string | | ID (not name) of the channel to fetch the schedule from | | `twitch_channel_id` | ✅ | string | | ID (not name) of the channel to fetch the schedule from |
| `twitch_client_id` | ✅ | string | | Twitch client ID the token was issued for | | `twitch_client_id` | ✅ | string | | Twitch client ID the token was issued for |
| `twitch_token` | ✅ | string | | Token for the user the `twitch_channel_id` belongs to | | `twitch_token` | ✅ | string | | Token for the user the `twitch_channel_id` belongs to |
@ -128,7 +121,7 @@ Posts stream schedule derived from Twitch schedule as embed in Discord channel
| `embed_color` | | int64 | `0x2ECC71` | Integer representation of the hex color for the embed | | `embed_color` | | int64 | `0x2ECC71` | Integer representation of the hex color for the embed |
| `embed_description` | | string | | Description for the embed block | | `embed_description` | | string | | Description for the embed block |
| `embed_thumbnail_height` | | int64 | | Height of the thumbnail | | `embed_thumbnail_height` | | int64 | | Height of the thumbnail |
| `embed_thumbnail_url` | | string | | Publically hosted image URL to u100se as thumbnail | | `embed_thumbnail_url` | | string | | Publically hosted image URL to use as thumbnail |
| `embed_thumbnail_width` | | int64 | | Width of the thumbnail | | `embed_thumbnail_width` | | int64 | | Width of the thumbnail |
| `schedule_entries` | | int64 | `5` | How many schedule entries to add to the embed as fields | | `schedule_entries` | | int64 | `5` | How many schedule entries to add to the embed as fields |
| `schedule_past_time` | | duration | `15m` | How long in the past should the schedule contain an entry | | `schedule_past_time` | | duration | `15m` | How long in the past should the schedule contain an entry |