From 567ce0ebaa44433da0478885523b16b677c3bec1 Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Wed, 13 Aug 2025 19:59:21 +0800
Subject: Revamp placement of package docstrings

---
 forged/internal/ansiec/ansiec.go |  5 -----
 forged/internal/ansiec/doc.go    |  5 +++++
 forged/internal/bare/doc.go      |  8 ++++++++
 forged/internal/bare/package.go  |  8 --------
 forged/internal/git2c/client.go  |  1 -
 forged/internal/git2c/doc.go     |  2 ++
 forged/internal/irc/bot.go       |  1 -
 forged/internal/irc/doc.go       |  2 ++
 forged/internal/misc/misc.go     | 13 -------------
 forged/internal/misc/slices.go   | 17 +++++++++++++++++
 10 files changed, 34 insertions(+), 28 deletions(-)
 delete mode 100644 forged/internal/ansiec/ansiec.go
 create mode 100644 forged/internal/ansiec/doc.go
 create mode 100644 forged/internal/bare/doc.go
 delete mode 100644 forged/internal/bare/package.go
 create mode 100644 forged/internal/git2c/doc.go
 create mode 100644 forged/internal/irc/doc.go
 create mode 100644 forged/internal/misc/slices.go

(limited to 'forged/internal')

diff --git a/forged/internal/ansiec/ansiec.go b/forged/internal/ansiec/ansiec.go
deleted file mode 100644
index 542c564..0000000
--- a/forged/internal/ansiec/ansiec.go
+++ /dev/null
@@ -1,5 +0,0 @@
-// SPDX-License-Identifier: AGPL-3.0-only
-// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
-
-// Package ansiec provides definitions for ANSI escape sequences.
-package ansiec
diff --git a/forged/internal/ansiec/doc.go b/forged/internal/ansiec/doc.go
new file mode 100644
index 0000000..542c564
--- /dev/null
+++ b/forged/internal/ansiec/doc.go
@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
+
+// Package ansiec provides definitions for ANSI escape sequences.
+package ansiec
diff --git a/forged/internal/bare/doc.go b/forged/internal/bare/doc.go
new file mode 100644
index 0000000..2f12f55
--- /dev/null
+++ b/forged/internal/bare/doc.go
@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
+
+// Package bare provides primitives to encode and decode BARE messages.
+//
+// There is no guarantee that this is compatible with the upstream
+// implementation at https://git.sr.ht/~sircmpwn/go-bare.
+package bare
diff --git a/forged/internal/bare/package.go b/forged/internal/bare/package.go
deleted file mode 100644
index 2f12f55..0000000
--- a/forged/internal/bare/package.go
+++ /dev/null
@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
-
-// Package bare provides primitives to encode and decode BARE messages.
-//
-// There is no guarantee that this is compatible with the upstream
-// implementation at https://git.sr.ht/~sircmpwn/go-bare.
-package bare
diff --git a/forged/internal/git2c/client.go b/forged/internal/git2c/client.go
index ed9390c..d8dc2ea 100644
--- a/forged/internal/git2c/client.go
+++ b/forged/internal/git2c/client.go
@@ -1,7 +1,6 @@
 // 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/forged/internal/git2c/doc.go b/forged/internal/git2c/doc.go
new file mode 100644
index 0000000..e14dae0
--- /dev/null
+++ b/forged/internal/git2c/doc.go
@@ -0,0 +1,2 @@
+// Package git2c provides routines to interact with the git2d backend daemon.
+package git2c
diff --git a/forged/internal/irc/bot.go b/forged/internal/irc/bot.go
index 1c6d32f..3ebac89 100644
--- a/forged/internal/irc/bot.go
+++ b/forged/internal/irc/bot.go
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 // SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
 
-// Package irc provides basic IRC bot functionality.
 package irc
 
 import (
diff --git a/forged/internal/irc/doc.go b/forged/internal/irc/doc.go
new file mode 100644
index 0000000..dcfca82
--- /dev/null
+++ b/forged/internal/irc/doc.go
@@ -0,0 +1,2 @@
+// Package irc provides basic IRC bot functionality.
+package irc
diff --git a/forged/internal/misc/misc.go b/forged/internal/misc/misc.go
index 398020a..e9e10ab 100644
--- a/forged/internal/misc/misc.go
+++ b/forged/internal/misc/misc.go
@@ -3,16 +3,3 @@
 
 // Package misc provides miscellaneous functions and other definitions.
 package misc
-
-import "strings"
-
-// sliceContainsNewlines returns true if and only if the given slice contains
-// one or more strings that contains newlines.
-func SliceContainsNewlines(s []string) bool {
-	for _, v := range s {
-		if strings.Contains(v, "\n") {
-			return true
-		}
-	}
-	return false
-}
diff --git a/forged/internal/misc/slices.go b/forged/internal/misc/slices.go
new file mode 100644
index 0000000..3ad0211
--- /dev/null
+++ b/forged/internal/misc/slices.go
@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu <https://runxiyu.org>
+
+package misc
+
+import "strings"
+
+// sliceContainsNewlines returns true if and only if the given slice contains
+// one or more strings that contains newlines.
+func SliceContainsNewlines(s []string) bool {
+	for _, v := range s {
+		if strings.Contains(v, "\n") {
+			return true
+		}
+	}
+	return false
+}
-- 
cgit v1.2.3