From 8b7fa11042b8a4ec7ed34fde44ba7f67669c80ba Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Sun, 06 Apr 2025 02:29:10 +0800
Subject: [PATCH] Add package descriptions

---
 internal/ansiec/ansiec.go     | 2 ++
 internal/database/database.go | 1 +
 internal/embed/embed.go       | 1 +
 internal/git2c/client.go      | 1 +
 internal/irc/bot.go           | 1 +
 internal/misc/misc.go         | 1 +
 internal/oldgit/oldgit.go     | 2 ++
 internal/render/render.go     | 2 ++
 internal/unsorted/unsorted.go | 2 ++
 internal/web/web.go           | 2 ++

diff --git a/internal/ansiec/ansiec.go b/internal/ansiec/ansiec.go
new file mode 100644
index 0000000000000000000000000000000000000000..f212cb92b788af2729c2e1d6023ef3eff084bb9b
--- /dev/null
+++ b/internal/ansiec/ansiec.go
@@ -0,0 +1,2 @@
+// Package ansiec provides definitions for ANSI escape sequences.
+package ansiec
diff --git a/internal/database/database.go b/internal/database/database.go
index 27c3b38b676c088057939d8329fd02c3fe26fc1a..7b0bee76bc6d083c80d26b3b7cb19d5997900912 100644
--- a/internal/database/database.go
+++ b/internal/database/database.go
@@ -1,3 +1,4 @@
+// Package database provides stubs and wrappers for databases.
 package database
 
 import (
diff --git a/internal/embed/embed.go b/internal/embed/embed.go
index b1bcc8f538391a5027ef53225963f2f6b24f5dbd..5d171586a9f72ea22cfc86e2900656a0556250fe 100644
--- a/internal/embed/embed.go
+++ b/internal/embed/embed.go
@@ -1,3 +1,4 @@
+// Package embed provides embedded filesystems created in build-time.
 package embed
 
 import "embed"
diff --git a/internal/git2c/client.go b/internal/git2c/client.go
index f9b562f6f991c2781a636488c5d22abaa33bcd9a..d178c47089b5b99eac7680dc503bcadaaee662e4 100644
--- a/internal/git2c/client.go
+++ b/internal/git2c/client.go
@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 // SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
 
+// Package git2c provides routines to interact with the git2d backend daemon.
 package git2c
 
 import (
diff --git a/internal/irc/bot.go b/internal/irc/bot.go
index 6f7ba71f6c573fadb4d354fb9956c70e01a06ee8..b41f174665675bda332a28fe3b6ab144f267fb7a 100644
--- a/internal/irc/bot.go
+++ b/internal/irc/bot.go
@@ -1,3 +1,4 @@
+// Package irc provides basic IRC bot functionality.
 package irc
 
 import (
diff --git a/internal/misc/misc.go b/internal/misc/misc.go
index 3ad021187f02c8e6f8c888ae50263496b430050f..398020af366c8f8c3dc5ceca822afaba449340c8 100644
--- a/internal/misc/misc.go
+++ b/internal/misc/misc.go
@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 // SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
 
+// Package misc provides miscellaneous functions and other definitions.
 package misc
 
 import "strings"
diff --git a/internal/oldgit/oldgit.go b/internal/oldgit/oldgit.go
new file mode 100644
index 0000000000000000000000000000000000000000..d608d6d92e3e7b7c6cb8b26a1bd3457834185f11
--- /dev/null
+++ b/internal/oldgit/oldgit.go
@@ -0,0 +1,2 @@
+// Package oldgit provides deprecated functions that depend on go-git.
+package oldgit
diff --git a/internal/render/render.go b/internal/render/render.go
new file mode 100644
index 0000000000000000000000000000000000000000..242a9243a4d1687ffa3eaa0af2e743ccd0f22755
--- /dev/null
+++ b/internal/render/render.go
@@ -0,0 +1,2 @@
+// Package render provides functions to render code and READMEs.
+package render
diff --git a/internal/unsorted/unsorted.go b/internal/unsorted/unsorted.go
new file mode 100644
index 0000000000000000000000000000000000000000..c8908af10713b7064334021d6af87ccfc3ae242f
--- /dev/null
+++ b/internal/unsorted/unsorted.go
@@ -0,0 +1,2 @@
+// Package unsorted is where unsorted Go files from the old structure are kept.
+package unsorted
diff --git a/internal/web/web.go b/internal/web/web.go
new file mode 100644
index 0000000000000000000000000000000000000000..e745a8060f02e4c8542c15f88fc13d5317c99a12
--- /dev/null
+++ b/internal/web/web.go
@@ -0,0 +1,2 @@
+// Package web provides web-facing components of the forge.
+package web

-- 
2.48.1