From 567ce0ebaa44433da0478885523b16b677c3bec1 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Wed, 13 Aug 2025 19:59:21 +0800 Subject: [PATCH] Revamp placement of package docstrings --- forged/internal/ansiec/ansiec.go => forged/internal/ansiec/doc.go | 0 forged/internal/bare/package.go => forged/internal/bare/doc.go | 0 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 +++++++++++++++++ diff --git a/forged/internal/ansiec/ansiec.go b/forged/internal/ansiec/doc.go rename from forged/internal/ansiec/ansiec.go rename to forged/internal/ansiec/doc.go diff --git a/forged/internal/bare/package.go b/forged/internal/bare/doc.go rename from forged/internal/bare/package.go rename to forged/internal/bare/doc.go diff --git a/forged/internal/git2c/client.go b/forged/internal/git2c/client.go index ed9390c4d2369f6f84c6c1dd122ff7389eb9e483..d8dc2eaf28af138bb9c4d0723dd998fea05cbbe7 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 -// 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 0000000000000000000000000000000000000000..e14dae0d00a1e002f9e6a857dc0a47acbd91f564 --- /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 1c6d32fbcca9fc070b6f1be559c728df67d6d3dd..3ebac89b26dca4d0ce5ecbc83ad981ce7bbaa5a4 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 -// 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 0000000000000000000000000000000000000000..dcfca82dfa53529d3b3ed03d7a8f17e0d68e232b --- /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 398020af366c8f8c3dc5ceca822afaba449340c8..e9e10ab8cac4c9d1c5ef05777de5f83eeb4b938b 100644 --- a/forged/internal/misc/misc.go +++ b/forged/internal/misc/misc.go @@ -3,16 +3,3 @@ // SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu // 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 0000000000000000000000000000000000000000..3ad021187f02c8e6f8c888ae50263496b430050f --- /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 + +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 +} -- 2.48.1