Fix incorrect docs for Channel() funcs

disgoorg · Aug 31, 2023 · 650fa09 · 650fa09
1 parent cdef17e
commit 650fa09
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/events/guild_invite_events.go b/events/guild_invite_events.go
@@ -14,7 +14,7 @@ type GenericInvite struct {
 	Code      string
 }
 
-// Channel returns the Channel the GenericInvite happened in.
+// Channel returns the discord.GuildChannel the GenericInvite happened in.
 func (e *GenericInvite) Channel() (discord.GuildChannel, bool) {
 	return e.Client().Caches().Channel(e.ChannelID)
 }

diff --git a/events/guild_member_events.go b/events/guild_member_events.go
@@ -47,7 +47,7 @@ type GuildMemberTypingStart struct {
 	Member    discord.Member
 }
 
-// Channel returns the discord.BaseGuildMessageChannel the GuildMemberTypingStart happened in
+// Channel returns the discord.GuildMessageChannel the GuildMemberTypingStart happened in
 func (e *GuildMemberTypingStart) Channel() (discord.GuildMessageChannel, bool) {
 	return e.Client().Caches().GuildMessageChannel(e.ChannelID)
 }
diff --git a/events/guild_message_events.go b/events/guild_message_events.go
@@ -21,7 +21,7 @@ func (e *GenericGuildMessage) Guild() (discord.Guild, bool) {
 	return e.Client().Caches().Guild(e.GuildID)
 }
 
-// Channel returns the discord.DMChannel where the GenericGuildMessage happened
+// Channel returns the discord.GuildMessageChannel where the GenericGuildMessage happened
 func (e *GenericGuildMessage) Channel() (discord.GuildMessageChannel, bool) {
 	return e.Client().Caches().GuildMessageChannel(e.ChannelID)
 }

diff --git a/events/guild_webhooks_update_events.go b/events/guild_webhooks_update_events.go
@@ -19,7 +19,7 @@ func (e *WebhooksUpdate) Guild() (discord.Guild, bool) {
 	return e.Client().Caches().Guild(e.GuildId)
 }
 
-// Channel returns the Channel the webhook was updated in.
+// Channel returns the discord.GuildMessageChannel webhook was updated in.
 // This will only return cached channels!
 func (e *WebhooksUpdate) Channel() (discord.GuildMessageChannel, bool) {
 	return e.Client().Caches().GuildMessageChannel(e.ChannelID)