diff options
| author | Runxi Yu <me@runxiyu.org> | 2025-04-06 02:29:10 +0800 |
|---|---|---|
| committer | Runxi Yu <me@runxiyu.org> | 2025-04-06 02:29:10 +0800 |
| commit | 8b7fa11042b8a4ec7ed34fde44ba7f67669c80ba (patch) | |
| tree | a43d19aa012b6d168e5217d41028062bc0565af2 | |
| parent | Fix missing initialization of globalData and ircBot (diff) | |
| download | forge-8b7fa11042b8a4ec7ed34fde44ba7f67669c80ba.tar.gz forge-8b7fa11042b8a4ec7ed34fde44ba7f67669c80ba.tar.zst forge-8b7fa11042b8a4ec7ed34fde44ba7f67669c80ba.zip | |
Add package descriptions
| -rw-r--r-- | internal/ansiec/ansiec.go | 2 | ||||
| -rw-r--r-- | internal/database/database.go | 1 | ||||
| -rw-r--r-- | internal/embed/embed.go | 1 | ||||
| -rw-r--r-- | internal/git2c/client.go | 1 | ||||
| -rw-r--r-- | internal/irc/bot.go | 1 | ||||
| -rw-r--r-- | internal/misc/misc.go | 1 | ||||
| -rw-r--r-- | internal/oldgit/oldgit.go | 2 | ||||
| -rw-r--r-- | internal/render/render.go | 2 | ||||
| -rw-r--r-- | internal/unsorted/unsorted.go | 2 | ||||
| -rw-r--r-- | internal/web/web.go | 2 |
10 files changed, 15 insertions, 0 deletions
diff --git a/internal/ansiec/ansiec.go b/internal/ansiec/ansiec.go new file mode 100644 index 0000000..f212cb9 --- /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 27c3b38..7b0bee7 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 b1bcc8f..5d17158 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 f9b562f..d178c47 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 6f7ba71..b41f174 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 3ad0211..398020a 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 0000000..d608d6d --- /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 0000000..242a924 --- /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 0000000..c8908af --- /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 0000000..e745a80 --- /dev/null +++ b/internal/web/web.go @@ -0,0 +1,2 @@ +// Package web provides web-facing components of the forge. +package web |