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

internal/bot/commands.go

@@ -22,11 +22,14 @@ const (
 	ICalTimestampFormatLocal = "20060102T150405"
 )
 
+// CommandHandler is a function that handles a slash command interaction.
 type CommandHandler func(b *Bot, s *discordgo.Session, i *discordgo.InteractionCreate) error
 
 var (
+	// CommandDefinitions is a list of all the bot's command definitions.
 	CommandDefinitions = []*discordgo.ApplicationCommand{TermCommandDefinition, TimeCommandDefinition, SearchCommandDefinition, IcsCommandDefinition}
-	CommandHandlers    = map[string]CommandHandler{
+	// CommandHandlers is a map of command names to their handlers.
+	CommandHandlers = map[string]CommandHandler{
 		TimeCommandDefinition.Name:   TimeCommandHandler,
 		TermCommandDefinition.Name:   TermCommandHandler,
 		SearchCommandDefinition.Name: SearchCommandHandler,
@@ -82,6 +85,7 @@ var SearchCommandDefinition = &discordgo.ApplicationCommand{
 	},
 }
 
+// SearchCommandHandler handles the /search command, which allows users to search for courses.
 func SearchCommandHandler(b *Bot, s *discordgo.Session, i *discordgo.InteractionCreate) error {
 	data := i.ApplicationCommandData()
 	query := api.NewQuery().Credits(3, 6)
@@ -283,6 +287,7 @@ var TermCommandDefinition = &discordgo.ApplicationCommand{
 	},
 }
 
+// TermCommandHandler handles the /terms command, which allows users to search for terms.
 func TermCommandHandler(b *Bot, s *discordgo.Session, i *discordgo.InteractionCreate) error {
 	data := i.ApplicationCommandData()
 
@@ -353,6 +358,7 @@ var TimeCommandDefinition = &discordgo.ApplicationCommand{
 	},
 }
 
+// TimeCommandHandler handles the /time command, which allows users to get the meeting times for a course.
 func TimeCommandHandler(b *Bot, s *discordgo.Session, i *discordgo.InteractionCreate) error {
 	fetch_time := time.Now()
 	crn := i.ApplicationCommandData().Options[0].IntValue()
@@ -428,6 +434,7 @@ var IcsCommandDefinition = &discordgo.ApplicationCommand{
 	},
 }
 
+// IcsCommandHandler handles the /ics command, which allows users to generate an ICS file for a course.
 func IcsCommandHandler(b *Bot, s *discordgo.Session, i *discordgo.InteractionCreate) error {
 	// Parse all options
 	options := internal.ParseOptions(i.ApplicationCommandData().Options)

internal/bot/handlers.go

@@ -9,6 +9,7 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
+// RegisterHandlers registers the bot's command handlers.
 func (b *Bot) RegisterHandlers() {
 	b.Session.AddHandler(func(internalSession *discordgo.Session, interaction *discordgo.InteractionCreate) {
 		// Handle commands during restart (highly unlikely, but just in case)

internal/bot/state.go

@@ -1,3 +1,4 @@
+// Package bot provides the core functionality for the Discord bot.
 package bot
 
 import (
@@ -10,6 +11,7 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
+// Bot represents the state of the Discord bot.
 type Bot struct {
 	Session   *discordgo.Session
 	API       *api.API
@@ -17,14 +19,17 @@ type Bot struct {
 	isClosing bool
 }
 
+// New creates a new Bot instance.
 func New(s *discordgo.Session, a *api.API, c *config.Config) *Bot {
 	return &Bot{Session: s, API: a, Config: c}
 }
 
+// SetClosing marks the bot as closing, preventing new commands from being processed.
 func (b *Bot) SetClosing() {
 	b.isClosing = true
 }
 
+// GetSession ensures a valid session is available and selects the default term.
 func (b *Bot) GetSession() (string, error) {
 	sessionID := b.API.EnsureSession()
 	term := api.Default(time.Now()).ToString()