xevion/banner
1
0
Fork 0
mirror of https://github.com/Xevion/banner.git synced 2025-12-15 08:11:11 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: add trivial documentation for all types, functions, packages etc.

Browse Source
This commit is contained in:
Xevion
2025-08-26 11:39:30 -05:00
parent deef4cabaa
commit 5a722d16c6
15 changed files with 211 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
internal/meta.go
View File

@@ -1,3 +1,4 @@
// Package internal provides shared functionality for the banner application.
package internal
import (
@@ -10,7 +11,7 @@ import (
log "github.com/rs/zerolog/log"
)
// GetGuildName returns the name of the guild with the given ID, utilizing Redis to cache the value
// GetGuildName returns the name of a guild by its ID, using Redis for caching.
func GetGuildName(cfg *config.Config, session *discordgo.Session, guildID string) string {
// Create a timeout context for Redis operations
ctx, cancel := context.WithTimeout(cfg.Ctx, 5*time.Second)
@@ -52,7 +53,7 @@ func GetGuildName(cfg *config.Config, session *discordgo.Session, guildID string
return guild.Name
}
// GetChannelName returns the name of the channel with the given ID, utilizing Redis to cache the value
// GetChannelName returns the name of a channel by its ID, using Redis for caching.
func GetChannelName(cfg *config.Config, session *discordgo.Session, channelID string) string {
// Create a timeout context for Redis operations
ctx, cancel := context.WithTimeout(cfg.Ctx, 5*time.Second)